license_generator 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-01-11
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,25 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+features/development.feature
+features/step_definitions/common_steps.rb
+features/support/common.rb
+features/support/env.rb
+features/support/matchers.rb
+lib/license_generator.rb
+license_generator.gemspec
+rubygems_generators/license/USAGE
+rubygems_generators/license/license_generator.rb
+rubygems_generators/license/templates/agpl.txt
+rubygems_generators/license/templates/copyright.erb
+rubygems_generators/license/templates/gpl.txt
+script/console
+script/destroy
+script/generate
+spec/license_generator_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake
+test/test_generator_helper.rb
+test/test_license_generator.rb

data/README.rdoc

@@ -0,0 +1,52 @@
+= license_generator
+
+* http://projects.tryphon.eu/license_generator
+
+== DESCRIPTION:
+
+Choose the license and generate required documents
+
+== FEATURES/PROBLEMS:
+
+* install licenses
+* support GPL and AGPL (for the moment)
+* TODO : rake tasks to manage file headers
+
+== SYNOPSIS:
+
+  ./script/generate license --author="John Doe" --years="2007,2009" --license=gpl
+     create  COPYING
+     create  COPYRIGHT
+
+== REQUIREMENTS:
+
+* rubigen
+
+== INSTALL:
+
+* sudo gem install license_generator
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Alban Peignier
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/license_generator'
+
+Hoe.plugin :newgem
+Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'license_generator' do
+  self.developer 'Alban Peignier', 'alban@tryphon.eu'
+  self.rubyforge_name       = self.name
+  self.extra_deps         = [['rubigen','>= 1.5.2']]
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+task :default => [:spec, :features]

data/features/development.feature

@@ -0,0 +1,13 @@
+Feature: Development processes of newgem itself (rake tasks)
+
+  As a Newgem maintainer or contributor
+  I want rake tasks to maintain and release the gem
+  So that I can spend time on the tests and code, and not excessive time on maintenance processes
+    
+  Scenario: Generate RubyGem
+    Given this project is active project folder
+    And "pkg" folder is deleted
+    When I invoke task "rake gem"
+    Then folder "pkg" is created
+    And file with name matching "pkg/*.gem" is created else you should run "rake manifest" to fix this
+    And gem spec key "rdoc_options" contains /--mainREADME.rdoc/

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,163 @@
+Given /^this project is active project folder/ do
+  @active_project_folder = File.expand_path(File.dirname(__FILE__) + "/../..")
+end
+
+Given /^env variable \$([\w_]+) set to "(.*)"/ do |env_var, value|
+  ENV[env_var] = value
+end
+
+Given /"(.*)" folder is deleted/ do |folder|
+  in_project_folder { FileUtils.rm_rf folder }
+end
+
+When /^I invoke "(.*)" generator with arguments "(.*)"$/ do |generator, arguments|
+  @stdout = StringIO.new
+  in_project_folder do
+    if Object.const_defined?("APP_ROOT")
+      APP_ROOT.replace(FileUtils.pwd)
+    else 
+      APP_ROOT = FileUtils.pwd
+    end
+    run_generator(generator, arguments.split(' '), SOURCES, :stdout => @stdout)
+  end
+  File.open(File.join(@tmp_root, "generator.out"), "w") do |f|
+    @stdout.rewind
+    f << @stdout.read
+  end
+end
+
+When /^I run executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  in_project_folder do
+    system "#{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When /^I run project executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  in_project_folder do
+    system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When /^I run local executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  executable = File.expand_path(File.join(File.dirname(__FILE__), "/../../bin", executable))
+  in_project_folder do
+    system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When /^I invoke task "rake (.*)"/ do |task|
+  @stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
+  in_project_folder do
+    system "rake #{task} --trace > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+Then /^folder "(.*)" (is|is not) created/ do |folder, is|
+  in_project_folder do
+    File.exists?(folder).should(is == 'is' ? be_true : be_false)
+  end
+end
+
+Then /^file "(.*)" (is|is not) created/ do |file, is|
+  in_project_folder do
+    File.exists?(file).should(is == 'is' ? be_true : be_false)
+  end
+end
+
+Then /^file with name matching "(.*)" is created/ do |pattern|
+  in_project_folder do
+    Dir[pattern].should_not be_empty
+  end
+end
+
+Then /^file "(.*)" contents (does|does not) match \/(.*)\// do |file, does, regex|
+  in_project_folder do
+    actual_output = File.read(file)
+    (does == 'does') ?
+      actual_output.should(match(/#{regex}/)) :
+      actual_output.should_not(match(/#{regex}/))
+  end
+end
+
+Then /gem file "(.*)" and generated file "(.*)" should be the same/ do |gem_file, project_file|
+  File.exists?(gem_file).should be_true
+  File.exists?(project_file).should be_true
+  gem_file_contents = File.read(File.dirname(__FILE__) + "/../../#{gem_file}")
+  project_file_contents = File.read(File.join(@active_project_folder, project_file))
+  project_file_contents.should == gem_file_contents
+end
+
+Then /^(does|does not) invoke generator "(.*)"$/ do |does_invoke, generator|
+  actual_output = File.read(@stdout)
+  does_invoke == "does" ?
+    actual_output.should(match(/dependency\s+#{generator}/)) :
+    actual_output.should_not(match(/dependency\s+#{generator}/))
+end
+
+Then /help options "(.*)" and "(.*)" are displayed/ do |opt1, opt2|
+  actual_output = File.read(@stdout)
+  actual_output.should match(/#{opt1}/)
+  actual_output.should match(/#{opt2}/)
+end
+
+Then /^I should see$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should contain(text)
+end
+
+Then /^I should not see$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should_not contain(text)
+end
+
+Then /^I should see exactly$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should == text
+end
+
+Then /^I should see all (\d+) tests pass/ do |expected_test_count|
+  expected = %r{^#{expected_test_count} tests, \d+ assertions, 0 failures, 0 errors}
+  actual_output = File.read(@stdout)
+  actual_output.should match(expected)
+end
+
+Then /^I should see all (\d+) examples pass/ do |expected_test_count|
+  expected = %r{^#{expected_test_count} examples?, 0 failures}
+  actual_output = File.read(@stdout)
+  actual_output.should match(expected)
+end
+
+Then /^yaml file "(.*)" contains (\{.*\})/ do |file, yaml|
+  in_project_folder do
+    yaml = eval yaml
+    YAML.load(File.read(file)).should == yaml
+  end
+end
+
+Then /^Rakefile can display tasks successfully/ do
+  @stdout = File.expand_path(File.join(@tmp_root, "rakefile.out"))
+  in_project_folder do
+    system "rake -T > #{@stdout} 2> #{@stdout}"
+  end
+  actual_output = File.read(@stdout)
+  actual_output.should match(/^rake\s+\w+\s+#\s.*/)
+end
+
+Then /^task "rake (.*)" is executed successfully/ do |task|
+  @stdout.should_not be_nil
+  actual_output = File.read(@stdout)
+  actual_output.should_not match(/^Don't know how to build task '#{task}'/)
+  actual_output.should_not match(/Error/i)
+end
+
+Then /^gem spec key "(.*)" contains \/(.*)\// do |key, regex|
+  in_project_folder do
+    gem_file = Dir["pkg/*.gem"].first
+    gem_spec = Gem::Specification.from_yaml(`gem spec #{gem_file}`)
+    spec_value = gem_spec.send(key.to_sym)
+    spec_value.to_s.should match(/#{regex}/)
+  end
+end

data/features/support/common.rb

@@ -0,0 +1,29 @@
+module CommonHelpers
+  def in_tmp_folder(&block)
+    FileUtils.chdir(@tmp_root, &block)
+  end
+
+  def in_project_folder(&block)
+    project_folder = @active_project_folder || @tmp_root
+    FileUtils.chdir(project_folder, &block)
+  end
+
+  def in_home_folder(&block)
+    FileUtils.chdir(@home_path, &block)
+  end
+
+  def force_local_lib_override(project_name = @project_name)
+    rakefile = File.read(File.join(project_name, 'Rakefile'))
+    File.open(File.join(project_name, 'Rakefile'), "w+") do |f|
+      f << "$:.unshift('#{@lib_path}')\n"
+      f << rakefile
+    end
+  end
+
+  def setup_active_project_folder project_name
+    @active_project_folder = File.join(@tmp_root, project_name)
+    @project_name = project_name
+  end
+end
+
+World(CommonHelpers)

data/features/support/env.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + "/../../lib/license_generator"
+
+gem 'cucumber'
+require 'cucumber'
+gem 'rspec'
+require 'spec'
+
+Before do
+  @tmp_root = File.dirname(__FILE__) + "/../../tmp"
+  @home_path = File.expand_path(File.join(@tmp_root, "home"))
+  FileUtils.rm_rf   @tmp_root
+  FileUtils.mkdir_p @home_path
+  ENV['HOME'] = @home_path
+end

data/features/support/matchers.rb

@@ -0,0 +1,11 @@
+module Matchers
+  def contain(expected)
+    simple_matcher("contain #{expected.inspect}") do |given, matcher|
+      matcher.failure_message = "expected #{given.inspect} to contain #{expected.inspect}"
+      matcher.negative_failure_message = "expected #{given.inspect} not to contain #{expected.inspect}"
+      given.index expected
+    end
+  end
+end
+
+World(Matchers)

data/lib/license_generator.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module LicenseGenerators
+  VERSION = '0.0.1'
+end

data/license_generator.gemspec

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{license_generator}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alban Peignier"]
+  s.date = %q{2010-01-12}
+  s.description = %q{Choose the license and generate required documents}
+  s.email = ["alban@tryphon.eu"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "rubygems_generators/license/templates/agpl.txt", "rubygems_generators/license/templates/gpl.txt"]
+  s.files = ["History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "features/development.feature", "features/step_definitions/common_steps.rb", "features/support/common.rb", "features/support/env.rb", "features/support/matchers.rb", "lib/license_generator.rb", "license_generator.gemspec", "rubygems_generators/license/USAGE", "rubygems_generators/license/license_generator.rb", "rubygems_generators/license/templates/agpl.txt", "rubygems_generators/license/templates/copyright.erb", "rubygems_generators/license/templates/gpl.txt", "script/console", "script/destroy", "script/generate", "spec/license_generator_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/rspec.rake", "test/test_generator_helper.rb", "test/test_license_generator.rb"]
+  s.homepage = %q{http://projects.tryphon.eu/license_generator}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{license_generator}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Choose the license and generate required documents}
+  s.test_files = ["test/test_license_generator.rb", "test/test_generator_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rubigen>, [">= 1.5.2"])
+      s.add_development_dependency(%q<rubyforge>, [">= 2.0.3"])
+      s.add_development_dependency(%q<gemcutter>, [">= 0.3.0"])
+      s.add_development_dependency(%q<hoe>, [">= 2.5.0"])
+    else
+      s.add_dependency(%q<rubigen>, [">= 1.5.2"])
+      s.add_dependency(%q<rubyforge>, [">= 2.0.3"])
+      s.add_dependency(%q<gemcutter>, [">= 0.3.0"])
+      s.add_dependency(%q<hoe>, [">= 2.5.0"])
+    end
+  else
+    s.add_dependency(%q<rubigen>, [">= 1.5.2"])
+    s.add_dependency(%q<rubyforge>, [">= 2.0.3"])
+    s.add_dependency(%q<gemcutter>, [">= 0.3.0"])
+    s.add_dependency(%q<hoe>, [">= 2.5.0"])
+  end
+end

data/rubygems_generators/license/USAGE

@@ -0,0 +1,12 @@
+Description:
+
+ Install required resources to place a program under a selected license
+
+ Support gpl and agpl licenses for the moment. Based on information provided
+ by http://www.gnu.org/licenses/gpl-howto.html.
+  
+Usage:
+  
+ ./script/generate license --author="John Doe" --years="2007,2009" --license=gpl
+     create  COPYING
+     create  COPYRIGHT

data/rubygems_generators/license/license_generator.rb

@@ -0,0 +1,75 @@
+class LicenseGenerator < RubiGen::Base
+
+  default_options :years => ""
+
+  attr_reader :name
+  attr_accessor :author, :license, :years
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @name = args.shift
+    extract_options
+
+    usage if [author,license,years].any?(&:blank?)
+  end
+
+  def manifest
+    record do |m|
+      m.template "gpl.txt", "COPYING"
+      m.template "copyright.erb", "COPYRIGHT"
+
+      # m.directory 'some_folder'
+      # m.template           "template.rb.erb", "some_file_after_erb.rb"
+      # m.template_copy_each ["template.rb", "template2.rb"]
+      # m.template_copy_each ["template.rb", "template2.rb"], "some/path"
+      # m.file           "file", "some_file_copied"
+      # m.file_copy_each ["path/to/file", "path/to/file2"]
+      # m.file_copy_each ["path/to/file", "path/to/file2"], "some/path"
+    end
+  end
+
+  def license=(license)
+    @license = license.blank? ? nil : license.to_sym
+  end
+
+  def years=(years_definition)
+    if String === years_definition
+      years_definition = years_definition.split(',').collect(&:to_i).sort
+      years_definition << Time.now.year
+    end
+
+    @years = years_definition
+  end
+
+  def license_name
+    @@license_names[license]
+  end
+
+  @@license_names = { :gpl => "GNU General public", 
+    :agpl => "GNU Affero General public" }
+
+  def self.license_names
+    @@license_names
+  end
+
+  protected
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      opts.on("-a", "--author=\"copyright owner\"", String,
+              "The name(s) associated to the copyright") { |o| options[:author] = o }
+      opts.on("-l", "--license=gpl|agpl", String,
+              "The selected license : gpl, agpl (for the moment)") { |o| options[:license] = o }
+      opts.on("-y", "--years=year[,year1,...]", String,
+              "The proper year(s) for each release. The current year is added by default", "Default: none") { |o| options[:years] = o }
+      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def extract_options
+      self.author = options[:author]
+      self.license = options[:license]
+      self.years = options[:years]
+    end
+end