license-generator 0.0.1 → 0.1.0

data/README.md

@@ -2,33 +2,32 @@
 
 Generate an open source license for your projects.
 
-## Usage:
+## Installation
 
-    lickjen [license] [options]
+    gem install lickjen
 
-I thought a phonetic spelling would be easy to remember. My apologies to
-anyone named Jennifer.
+## Usage:
 
-## Supported licenses:
+    lickjen [license] [options]
 
-* [The BSD License](http://www.opensource.org/licenses/bsd-license.php)
+Too see the available license templates:
 
-        lickjen bsd --name=[your name] --organization=[your organization]
+    lickjen list
 
 ### Please add some!
 
 There are a lot. See <http://www.opensource.org/licenses/alphabetical>.
 
-1. Fork the project
-2. Create a branch for your new license.
-3. Add a cucumber feature for your license: see `features/bsd_license.feature` for an example.
-4. Add a spec for your new license task to `spec/app_spec.rb`. Use the others as reference.
-5. Add your license task to `lib/license-generator/app.rb` and license template to `templates/[license].erb`. Use the others as reference.
-6. Add your new license to this README under "Supported licenses".
-7. Push it and send a pull request.
-8. I will pull it, bump the version number, and add you to the credits for fame and glory.
+Simply fork, add an ERB template to the `templates` directory, and send me a
+pull request.
+
+Since it's ERB you can use ruby to include things like the current date. You
+can also prompt the user for input like this:
+
+    <%= option(:name) %>
 
 ## Credits
 
 * Justin Blake <justin@hentzia.com>
-* Bill Evans (help naming the binary)
+* Bill Evans (help naming the binary and pushing to make it not hard to add
+  templates).

data/features/generate_license.feature

@@ -0,0 +1,14 @@
+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
+    And I type "Justin Blake"
+    And I type "Hentzia"
+    Then a file named "LICENSE" should exist
+    And the file "LICENSE" should contain a copyright notice for "Justin Blake"
+    And the file "LICENSE" should contain "Neither the name of Hentzia nor the names of its"
+
+  # TODO: add a couple more scenarios when we have more templates

data/features/get_help.feature

@@ -0,0 +1,19 @@
+Feature: Get help
+  In order to use this thing like a pro
+  As a small scared child
+  I want to get help
+
+  Scenario: Run licken with no args
+    When I run `lickjen`
+    Then I should see the generic help output
+    
+  @wip
+  Scenario: Run licken help task
+    When I run `lickjen help`
+    Then I should see the generic help output
+    
+  @wip
+  Scenario: Run lickjen help task for the list task
+  
+  @wip
+  Scenario: Run lickjen help task for the bsd template

data/features/list_templates.feature

@@ -0,0 +1,8 @@
+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`
+  Then the output should contain "bsd"
+  # TODO: add a couple more conditions when we have more templates

data/features/step_definitions/license-generator_steps.rb

@@ -6,3 +6,10 @@ Then /^the file "([^"]*)" should contain a copyright notice for "([^"]*)"$/ do |
   year = Time.now.year
   Then "the file \"#{file}\" should contain \"Copyright (c) #{year}, #{name}\""
 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
+end

data/lib/license-generator/app.rb

@@ -9,10 +9,34 @@ module LicenseGenerator
       File.expand_path('../../templates', File.dirname(__FILE__))
     end
     
-    desc "bsd", "Generate a BSD LICENSE"
-    method_options :name => :required, :organization => :required
-    def bsd
-      template "bsd.erb", "LICENSE"
+    desc "list", "List available license templates"
+    def list
+      Dir.foreach(self.class.source_root) do |template|
+        say template unless %w(. ..).include?(template)
+      end
+    end
+
+    def method_missing(meth, *args)
+      template "#{meth}.erb", "LICENSE"
+    end
+    
+    # Override Thor#help so it can give information about any class and any method.
+    def help(task = nil)
+      super
+      say "Templates:"
+      Dir.foreach(self.class.source_root) do |template|
+        unless %w(. ..).include?(template)
+          template = template.split('.').first
+          say "  lickjen #{template}\t# Generate a #{template} template"
+        end
+      end
+    end
+    
+    private
+    def option(name)
+      @template_options ||= {}
+      @template_options[name] ||= ask("#{name.capitalize}:")
+      @template_options[name]
     end
   end
 end

data/lib/license-generator/version.rb

@@ -1,5 +1,5 @@
 module License
   module Generator
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/spec/app_spec.rb

@@ -5,10 +5,24 @@ describe LicenseGenerator::App do
     @app = LicenseGenerator::App.new
   end
   
-  describe '#bsd' do
-    it "creates a LICENSE file from the bsd.erb template" do
-      @app.should_receive(:template).with("bsd.erb", "LICENSE")
-      @app.bsd
+  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
-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
+    @app.list
+  end
+  
+  it "has proper specs for the help task"
+end

data/templates/bsd.erb

@@ -1,4 +1,4 @@
-Copyright (c) <%= Time.now.year %>, <%= options[:name] %>
+Copyright (c) <%= Time.now.year %>, <%= option(:name) %>
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -9,7 +9,7 @@ modification, are permitted provided that the following conditions are met:
 * Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
-* Neither the name of <%= options[:organization] %> nor the names of its
+* Neither the name of <%= option(:organization) %> nor the names of its
   contributors may be used to endorse or promote products derived from this
   software without specific prior written permission.
 

metadata

@@ -1,83 +1,79 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: license-generator
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - Justin Blake
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-05 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: thor
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70227757839720 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70227757839720
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70227757809080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70227757809080
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70227757808360 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: cucumber
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70227757808360
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &70227757807700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: aruba
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70227757807700
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &70227757807020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
+  prerelease: false
+  version_requirements: *70227757807020
 description: Generate an open source license file in your project.
-email: 
+email:
 - justin@hentzia.com
-executables: 
+executables:
 - lickjen
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - CHANGELOG.md
 - Gemfile
@@ -85,7 +81,9 @@ files:
 - README.md
 - Rakefile
 - bin/lickjen
-- features/bsd_license.feature
+- features/generate_license.feature
+- features/get_help.feature
+- features/list_templates.feature
 - features/step_definitions/debug_steps.rb
 - features/step_definitions/license-generator_steps.rb
 - features/support/env.rb
@@ -97,36 +95,34 @@ files:
 - spec/app_spec.rb
 - spec/spec_helper.rb
 - templates/bsd.erb
-has_rdoc: true
-homepage: ""
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: license-generator
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Open Source License generator
-test_files: 
-- features/bsd_license.feature
+test_files:
+- features/generate_license.feature
+- features/get_help.feature
+- features/list_templates.feature
 - features/step_definitions/debug_steps.rb
 - features/step_definitions/license-generator_steps.rb
 - features/support/env.rb

data/features/bsd_license.feature

@@ -1,15 +0,0 @@
-Feature: Generate BSD License
-  In order to release my code under the BSD license
-  As an open source developer
-  I want to generate a BSD LICENSE file in my project
-  
-  Scenario: Run `lickjen bsd` with no arguments
-    When I successfully run `lickjen bsd`
-    Then the output should contain "No value provided for required options"    
-  
-  Scenario: Run `lickjen bsd --name='Justin Blake' --organization=Hentzia`
-    When I successfully run `lickjen bsd --name='Justin Blake' --organization=Hentzia`
-    Then the output should say the file "LICENSE" was created
-    And a file named "LICENSE" should exist
-    And the file "LICENSE" should contain a copyright notice for "Justin Blake"
-    And the file "LICENSE" should contain "Neither the name of Hentzia nor the names of its"