@@ -1,15 +1,17 @@ art_generators - Create & manage the lifecycle of digital art projects ====================================================================== -NOT READY FOR USE YET. +NOT READY FOR USE YET + +NOT ALL DESCRIBED FEATURES ARE IMPLEMENTED Currently only SVG-based projects are supported. Inspired by Ruby on Rails. -Making a Project ----------------- +Creating a Project +------------------ > art_project project-name @@ -21,9 +23,11 @@ Edit README to describe the project, and COPYING to describe the license terms o The Resources folder contains template.svg, which you can edit to set a default paper size and other features. +If you specify a version control system as an option (e.g. --git), the project directory will be initialised for that system and the project scripts will try to work with it. + -Making a Work -------------- +Creating a Work +--------------- In the project folder, type: @@ -49,16 +53,73 @@ Specifying works to copy with a slash in the name will cause the work to be copi Changing a Work's Status ------------------------ -TODO +> script/status --final mywork.svg + +Copies the file mywork.svg from workspace directory to the final directory. + +If you are using git or svn to version control the project this command notifies them of the change. Creating a Release of a Project ------------------------------- -TODO +> script/release 0.1 + +Creates an archive called project_name_0.1.tar.gz containing the final, discard and preparatory folders along with the LICENSE and README files. Creating a Web Page for a Project --------------------------------- -TODO +>script/web + +Creates png images and thumbnails of the contents of the final directory and creates a web page containing them in the web directory. + + +Example of Use +-------------- + +Create a project: + +> art_project test + +Change to the project directory: + +> cd test + +Create a work: + +> script/work first.svg + +Edit it: + +> inkscape preparatory/first.svg + +Create various other works and edit them: + +> script/work -c first.svg workX.svg +... + +Decide some are good and some are bad: + +> script/status --final work1.svg +> script/status --discard work2.svg +... + +Make a release archive: + +> script/release 0.0.1 + +make a web page: + +> script/web + +Have a rest, then start making more works. + + +Design Notes +------------ + +The directory structure and the tasks performed by the scripts come from the workflow Rob Myers developed for use in his own digital art projects. + +The idea of a system to generate a well-structured system of directories, files and scripts for use in a workflow comes from Ruby on Rails. README @@ -1,3 +1,19 @@ +# art_generators - create and manage digital art project directory structures +# Copyright (C) 2008 Rob Myers +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + Gem::Specification.new do |s| s.name = %q{art_generators} s.version = "0.0.1" art_generators.gemspec @@ -1,6 +1,22 @@ #!/usr/bin/env ruby +# art_generators - create and manage digital art project directory structures +# Copyright (C) 2008 Rob Myers +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + bindir = File.dirname(__FILE__) rootdir = File.dirname(bindir) -require rootdir + '/generator/project.rb' \ No newline at end of file +require rootdir + '/generator/project.rb' bin/art_project @@ -1,5 +1,21 @@ #!/usr/env ruby +# art_generators - create and manage digital art project directory structures +# Copyright (C) 2008 Rob Myers +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + # == Synopsis # Creates a directory structure for an SVG-based art project # and populates it with useful resources and scripts. @@ -18,6 +34,9 @@ # -v, --version Display version number # -a, --artist Your name # -l, --license Set the Creative Commons license URL for the project +# -g, --git Use the git version control system for the project +# -d, --date The year(s) for the copyright message +# # # == Author # Rob Myers <rob@robmyers.org> @@ -29,8 +48,9 @@ require 'fileutils' require 'optparse' +require 'ostruct' require 'rdoc/usage' - +#require 'liblicense' class ArtProject VERSION = "0.0.1" @@ -43,12 +63,7 @@ class ArtProject @source_dir = File.dirname(@generator_dir) @template_dir = @source_dir + '/templates' - @project_name = '' - @project_license_id = '' - @project_license_metadata = '' - @project_license_full_text = '' - @project_dir = '' - @project_artist = '' + initialize_project_details end def run @@ -62,16 +77,29 @@ class ArtProject protected + def initialize_project_details + @project = OpenStruct.new + @project.name = '' + @project.license_id = '' + @project.license_metadata = '' + @project.license_full_text = '' + @project.dir = '' + @project.artist = '' + @project.use_git = false + @project.use_svn = false + end + def parsed_options? opts = OptionParser.new opts.on('-v', '--version') { output_version ; exit 0 } opts.on('-h', '--help') { output_help } - opts.on('-l', '--license') do |license| - @project_license_id << license || '' - end - opts.on('-a', '--artist') do |artist| - @project_artist << artist || '' - end + opts.on("-g", "--git") {|git| @project.use_git << git} + #opts.on("-s", "--svn") {|svn| @project.use_svn << svn} + #opts.on('-l LICENSE', '--license LICENSE') do |license| + # @project.license_id << license + #end + opts.on('-a', '--artist') { |artist| @project.artist << artist } + opts.on("-d DATE", "--date DATE") {|date| @project.date << date} # This consumes matched arguments from @arguments opts.parse!(@arguments) rescue return false process_options @@ -92,13 +120,17 @@ class ArtProject if @arguments[0] == nil return false end + #if @project.git && @project.svn + # puts "Both git and svn specified. Please one or the other, not both." + # return false + #end #TODO Check the licence id is valid true end def process_arguments - @project_name = @arguments[0] # nil if unsupplied - @project_dir = Dir.pwd + "/" + @project_name + @project.name = @arguments[0] # nil if unsupplied + @project.dir = Dir.pwd + "/" + @project.name end def output_help @@ -120,17 +152,20 @@ class ArtProject end def make_directories - FileUtils.mkdir_p @project_dir - FileUtils.mkdir_p @project_dir + "/discard" - FileUtils.mkdir_p @project_dir + "/final" - FileUtils.mkdir_p @project_dir + "/preparatory" - FileUtils.mkdir_p @project_dir + "/releases" - FileUtils.mkdir_p @project_dir + "/resources" - FileUtils.mkdir_p @project_dir + "/script" + if File.exists? @project.dir + die "Cannot create project. Directory named {@project.dir} already exists. Please rename or move the existing directory." + end + FileUtils.mkdir_p @project.dir + FileUtils.mkdir_p @project.dir + "/discard" + FileUtils.mkdir_p @project.dir + "/final" + FileUtils.mkdir_p @project.dir + "/preparatory" + FileUtils.mkdir_p @project.dir + "/releases" + FileUtils.mkdir_p @project.dir + "/resources" + FileUtils.mkdir_p @project.dir + "/script" end def make_script_link(name) - script=@project_dir + "/script/" + name + script=@project.dir + "/script/" + name File.open(script, 'w') {|f| f.puts("#!/usr/bin/env ruby") f.puts("$project_dir=File.dirname(File.dirname(File.expand_path(__FILE__)))") @@ -145,14 +180,19 @@ class ArtProject end def make_files - File.open(@project_dir + "/resources/license.xml", 'w') {|f| - f.write(@project_license_metadata) } - File.open(@project_dir + "/COPYING", 'w') {|f| - f.write(@project_license_full_text) } - File.open(@project_dir + "/README", 'w') {|f| - f.write(@project_name + " by " + @project_artist + + File.open(@project.dir + "/resources/license.xml", 'w') {|f| + f.write(@project.license_metadata) } + File.open(@project.dir + "/COPYING", 'w') {|f| + f.write(@project.license_full_text) } + File.open(@project.dir + "/README", 'w') {|f| + f.write(@project.name + " by " + @project.artist + ".\nSee COPYING for license.\n") } - FileUtils.cp(@template_dir + "/template.svg", @project_dir + "/resources") + FileUtils.cp(@template_dir + "/template.svg", @project.dir + "/resources") + end + + def initialize_version_control + Kernel.system('git-init') if @project.use_git + #Kernel.system('svn-init') if @project.use_svn end def process_command @@ -160,6 +200,7 @@ class ArtProject make_directories make_script_links make_files + initialize_version_control end end generator/project.rb @@ -1,5 +1,21 @@ #!/usr/env ruby +# art_generators - create and manage digital art project directory structures +# Copyright (C) 2008 Rob Myers +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + require 'optparse' require 'rdoc/usage' generator/release.rb @@ -1,5 +1,21 @@ #!/usr/env ruby +# art_generators - create and manage digital art project directory structures +# Copyright (C) 2008 Rob Myers +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + #TODO: Ruby port of the web page creator require 'optparse' generator/web.rb @@ -1,5 +1,21 @@ #!/usr/env ruby +# art_generators - create and manage digital art project directory structures +# Copyright (C) 2008 Rob Myers +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + require 'fileutils' require 'optparse' require 'rdoc/usage' @@ -56,9 +72,9 @@ class ArtWork def parsed_options? opts = OptionParser.new - opts.on('-v', '--version') { output_version ; exit 0 } - opts.on('-h', '--help') { output_help } - opts.on('-c FILE', '--copy FILE') do |source| + opts.on('-v', '--version') { output_version ; exit 0 } + opts.on('-h', '--help') { output_help } + opts.on('-c FILE', '--copy FILE') do |source| @source_work_name = "#{@work_dir}/#{source}" || "#{@resource_dir}/template.svg" end @@ -100,13 +116,35 @@ class ArtWork puts "#{File.basename(__FILE__)} version #{VERSION}" end - def make_work + def make_work_file FileUtils.cp(@source_work_name, @destination_work_name) end - + + def using_git? + File.exists?("#{@project_path}/.git") + end + + def using_svn? + File.exists?("#{@project_path}/.svn") + end + + def add_work_to_version_control + if using_git? + Kernel.system("git add #{@destination_work_name}") + end + if using_svn? + Kernel.system("svn add #{@destination_work_name}") + end + end + def process_command - make_work + if File.exists? @destination_work_name + puts "File already exists #{@destination_work_name}" + exit 1 + end + make_work_file + add_work_to_version_control end end generator/work.rb @@ -1,4 +1,20 @@ #!/bin/bash +# art_generators - create and manage digital art project directory structures +# Copyright (C) 2008 Rob Myers +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + gem build art_generators.gemspec make_gem @@ -1,5 +1,21 @@ #!/bin/bash +# art_generators - create and manage digital art project directory structures +# Copyright (C) 2008 Rob Myers +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + # Utility function die(){ test_gem 4936fe4cdbdea34e451659dab9fc588615d7caaa Rob Myers rob@robmyers.org http://github.com/robmyers/art_generators/commit/4302916f80ba9b2beffb121f097ea6f91c19e9f1 4302916f80ba9b2beffb121f097ea6f91c19e9f1 2008-08-29T14:26:31-07:00 2008-08-29T14:26:31-07:00 Added GPL3 header to files, tidied up code, added some git support, fleshed out README. 5be463834569d9165e06856dcb88f47e3de44338 Rob Myers rob@robmyers.org