license-generator 0.2.0 → 0.3.0

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 pkg/*
 tmp/*
 .rvmrc
+.rbenv-gemsets

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# Version 0.3.0 (2012-11-19)
+
+* Binary renamed to licgen
+* New licenses:
+  * Apache 2.0
+  * GPL v1.0, v2.0, v3.0
+
 # Version 0.2.0 (2012-03-28)
 
 Add MIT license template.
@@ -12,4 +19,4 @@ Find and load templates dynamically. Makes adding templates much easier.
 
 # Version 0.0.1 (2011-05-05)
 
-First version. Only supports BSD license.
+First version. Only supports BSD license.

data/README.md

@@ -8,11 +8,11 @@ Generate an open source license for your projects.
 
 ## Usage:
 
-    lickjen [license]
+    licgen [license]
 
 Too see the available license templates:
 
-    lickjen list
+    licgen list
 
 ### Please add some!
 
@@ -28,6 +28,6 @@ can also prompt the user for input like this:
 
 ## Credits
 
-* Justin Blake <justin@hentzia.com>
-* Bill Evans (help naming the binary and pushing to make it not hard to add
-  templates).
+* Bill Evans (@thirteenpixels) for help naming the binary and pushing to make
+  it not hard to add templates.
+* Dayton Nolan (@daytonn) for fixes and new templates.

data/features/generate_license.feature

@@ -2,9 +2,9 @@ Feature: Generate a License
   In order to release my code to the public without worry
   As an open source developer
   I want to generate a LICENSE file in my project
-  
-  Scenario: Run `lickjen bsd`
-    When I run `lickjen bsd` interactively
+
+  Scenario: Run `licgen bsd`
+    When I run `licgen bsd` interactively
     And I type "Justin Blake"
     And I type "Hentzia"
     Then a file named "LICENSE" should exist
@@ -15,5 +15,5 @@ Feature: Generate a License
 
   @wip
   Scenario: Bad template name
-    When I run `lickjen asdfaowefnasdfaoweranasdflao`
+    When I run `licgen asdfaowefnasdfaoweranasdflao`
     Then I should see a graceful failure message

data/features/get_help.feature

@@ -4,16 +4,16 @@ Feature: Get help
   I want to get help
 
   Scenario: Run licken with no args
-    When I run `lickjen`
+    When I run `licgen`
     Then I should see the generic help output
-    
+
   @wip
   Scenario: Run licken help task
-    When I run `lickjen help`
+    When I run `licgen help`
     Then I should see the generic help output
-    
+
   @wip
-  Scenario: Run lickjen help task for the list task
-  
+  Scenario: Run licgen help task for the list task
+
   @wip
-  Scenario: Run lickjen help task for the bsd template
+  Scenario: Run licgen help task for the bsd template

data/features/list_templates.feature

@@ -2,7 +2,7 @@ Feature: List templates
   In order to see the available templates
   I want to list them like a boss
 
-Scenario: Run `lickjen list`
-  When I run `lickjen list`
+Scenario: Run `licgen list`
+  When I run `licgen list`
   Then the output should contain "bsd"
-  # TODO: add a couple more conditions when we have more templates
+  And the output should contain "mit"

data/features/step_definitions/license-generator_steps.rb

@@ -1,15 +1,15 @@
 Then /^the output should say the file "([^"]*)" was created$/ do |file|
-  Then "the output should match /create(.+)#{file}/"
+  steps %{Then "the output should match /create(.+)#{file}/"}
 end
 
 Then /^the file "([^"]*)" should contain a copyright notice for "([^"]*)"$/ do |file, name|
-  year = Time.now.year
-  Then "the file \"#{file}\" should contain \"Copyright (c) #{year}, #{name}\""
+  content = "Copyright (c) #{Time.now.year}, #{name}"
+  check_file_content(file, content, true)
 end
 
 Then /^I should see the generic help output$/ do
-  Then "the output should contain \"lickjen help [TASK]\""
-  Then "the output should contain \"lickjen list\""
-  Then "the output should contain \"lickjen bsd\""
-  # TODO: add more conditions when we have more templates
+  assert_partial_output("licgen help [TASK]", all_output)
+  assert_partial_output("licgen list", all_output)
+  assert_partial_output("licgen bsd", all_output)
+  assert_partial_output("licgen mit", all_output)
 end

data/lib/license-generator/app.rb

@@ -3,15 +3,15 @@ require 'thor'
 module LicenseGenerator
   class App < Thor
     include Thor::Actions
-    
+
     # Path to the templates
     def self.source_root
       File.expand_path('../../templates', File.dirname(__FILE__))
     end
-    
+
     desc "list", "List available license templates"
     def list
-      for_each_template do |template|
+      templates.each do |template|
         say template
       end
     end
@@ -19,33 +19,31 @@ module LicenseGenerator
     def method_missing(meth, *args)
       template "#{meth}.erb", "LICENSE"
     end
-    
+
     # Override Thor#help to include templates.
     def help(task = nil)
       super
       unless task
         say "Templates:"
-        for_each_template do |template|
-          say "  lickjen #{template}\t# Generate a #{template} template"
+        templates.each do |template|
+          say "  licgen #{template}\t# Generate #{template} license"
         end
       end
     end
-    
-    private
+
+    no_tasks do
+      def templates
+        @templates ||= Dir.glob("#{LicenseGenerator::App.source_root}/**/*.erb").map { |t| File.basename(t, '.erb') }
+      end
+    end
+
+  private
 
     def option(name)
       @template_options ||= {}
       @template_options[name] ||= ask("#{name.capitalize}:")
       @template_options[name]
     end
-    
-    def for_each_template
-      Dir.foreach(self.class.source_root) do |template|
-        unless %w(. ..).include?(template)
-          template = template.split('.').first
-          yield(template)
-        end
-      end
-    end
+
   end
 end

data/lib/license-generator/version.rb

@@ -1,5 +1,5 @@
 module License
   module Generator
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/license-generator.gemspec

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
 require "license-generator/version"
 
 Gem::Specification.new do |s|
@@ -11,18 +12,18 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/blaix/license-generator"
   s.summary     = %q{Open Source License generator}
   s.description = %q{Generate an open source license file in your project.}
-  
+
   s.rubyforge_project = "license-generator"
-  
+
   s.add_dependency "thor"
-  
+
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
   s.add_development_dependency "cucumber"
   s.add_development_dependency "aruba"
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables   << "licgen"
   s.require_paths = ["lib"]
 end

data/spec/app_spec.rb

@@ -1,28 +1,46 @@
 require 'spec_helper'
 
 describe LicenseGenerator::App do
+
   before do
+    # suppress console output to keep
+    # from interfering with test output
+    @_stdout = $stdout
+    $stdout = @stdout = StringIO.new
     @app = LicenseGenerator::App.new
   end
-  
-  it "finds template dynamically" do
-    %w(bsd gpl mit).each do |license|
-      @app.should_receive(:template).with("#{license}.erb", "LICENSE")
-      @app.send(license)
-    end
-  end
-  
-  it "can list available templates" do
-    LicenseGenerator::App.stub!(:source_root).and_return("template path")
-    Dir.should_receive(:foreach).with("template path").
-      and_yield(".").
-      and_yield("..").
-      and_yield("bsd").
-      and_yield("gpl")
-    @app.should_receive(:say).with(/bsd/).once
-    @app.should_receive(:say).with(/gpl/).once
+
+  after :each do
+    # restore $stdout
+    $stdout = @_stdout
+  end
+
+  it "has a class-wide source_root" do
+    LicenseGenerator::App.source_root.should == File.expand_path('../templates', File.dirname(__FILE__))
+  end
+
+  it "has templates" do
+    @app.templates.empty?.should be false
+  end
+
+  it "parses full template file names into template names" do
+    @app.templates.should include('apache-2.0')
+  end
+
+  it "lists available templates" do
+    @app.should_receive(:say).exactly(@app.templates.size).times
     @app.list
   end
-  
-  it "has proper specs for the help task"
+
+  it "displays the templates in the help command output" do
+    @app.should_receive(:say).with('Templates:')
+    @app.should_receive(:say).exactly(@app.templates.size).times.with(/^\s{2}licgen ([A-Za-z0-9\-\._]+)\b\s{1,}#\sGenerate\s([A-Za-z0-9\-\._]+)\slicense/)
+    @app.help
+  end
+
+  it "generates a template with a valid template name" do
+    @app.should_receive(:template).with('mit.erb', 'LICENSE')
+    @app.mit
+  end
+
 end

data/templates/apache-2.0.erb

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright <%= Time.now.year %> <%= option(:name) %>
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.