license-generator 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/*
+.rvmrc

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Version 0.0.1 (2011-05-05)
+
+First version. Only supports BSD license.

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in license-generator.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2011, Justin Blake
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+* 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 Hentzia nor the names of its
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,34 @@
+# OSS License Generator
+
+Generate an open source license for your projects.
+
+## Usage:
+
+    lickjen [license] [options]
+
+I thought a phonetic spelling would be easy to remember. My apologies to
+anyone named Jennifer.
+
+## Supported licenses:
+
+* [The BSD License](http://www.opensource.org/licenses/bsd-license.php)
+
+        lickjen bsd --name=[your name] --organization=[your organization]
+
+### 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.
+
+## Credits
+
+* Justin Blake <justin@hentzia.com>
+* Bill Evans (help naming the binary)

data/Rakefile

@@ -0,0 +1,29 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w(--color)
+end
+namespace :spec do
+  desc "Run specs with output in documentation format"
+  RSpec::Core::RakeTask.new(:doc) do |t|
+    t.rspec_opts = ["--color", "--format d"]
+  end
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features) do |features|
+  features.cucumber_opts = "features --tags ~@wip --format progress"
+end
+namespace :features do
+  Cucumber::Rake::Task.new(:pretty, "Run Cucumber features with output in pretty format") do |features|
+    features.cucumber_opts = "features --tags ~@wip --format pretty"
+  end
+  Cucumber::Rake::Task.new(:wip, "Run @wip (Work In Progress) Cucumber features") do |features|
+    features.cucumber_opts = "features --tags @wip --format progress"
+  end
+end
+
+task :default => [:spec, :features]

data/bin/lickjen

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.expand_path("../lib", File.dirname(__FILE__))
+$:.unshift lib_dir unless $:.include?(lib_dir)
+
+require "license-generator"
+LicenseGenerator::App.start

data/features/bsd_license.feature

@@ -0,0 +1,15 @@
+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"

data/features/step_definitions/debug_steps.rb

@@ -0,0 +1,3 @@
+Then /^I see the date$/ do
+  puts Time.now.inspect
+end

data/features/step_definitions/license-generator_steps.rb

@@ -0,0 +1,8 @@
+Then /^the output should say the file "([^"]*)" was created$/ do |file|
+  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}\""
+end

data/features/support/env.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'aruba/cucumber'

data/features/support/helpers.rb

@@ -0,0 +1,6 @@
+module LicenseGenerator
+  module CucumberHelpers
+  end
+end
+
+World(LicenseGenerator::CucumberHelpers)

data/lib/license-generator.rb

@@ -0,0 +1,3 @@
+module LicenseGenerator
+  autoload :App, "license-generator/app"
+end

data/lib/license-generator/app.rb

@@ -0,0 +1,18 @@
+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 "bsd", "Generate a BSD LICENSE"
+    method_options :name => :required, :organization => :required
+    def bsd
+      template "bsd.erb", "LICENSE"
+    end
+  end
+end

data/lib/license-generator/version.rb

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

data/license-generator.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "license-generator/version"
+
+Gem::Specification.new do |s|
+  s.name        = "license-generator"
+  s.version     = License::Generator::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Justin Blake"]
+  s.email       = ["justin@hentzia.com"]
+  s.homepage    = ""
+  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.require_paths = ["lib"]
+end

data/spec/app_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe LicenseGenerator::App do
+  before 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
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "rubygems"
+require "bundler/setup"
+
+require 'rspec'
+require 'license-generator'
+
+RSpec.configure do |config|
+  config.fail_fast = true
+end

data/templates/bsd.erb

@@ -0,0 +1,25 @@
+Copyright (c) <%= Time.now.year %>, <%= options[:name] %>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+* 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
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification 
+name: license-generator
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Justin Blake
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-05 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    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 
+    none: false
+    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 
+    none: false
+    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 
+    none: false
+    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 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Generate an open source license file in your project.
+email: 
+- justin@hentzia.com
+executables: 
+- lickjen
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/lickjen
+- features/bsd_license.feature
+- features/step_definitions/debug_steps.rb
+- features/step_definitions/license-generator_steps.rb
+- features/support/env.rb
+- features/support/helpers.rb
+- lib/license-generator.rb
+- lib/license-generator/app.rb
+- lib/license-generator/version.rb
+- license-generator.gemspec
+- spec/app_spec.rb
+- spec/spec_helper.rb
+- templates/bsd.erb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: license-generator
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Open Source License generator
+test_files: 
+- features/bsd_license.feature
+- features/step_definitions/debug_steps.rb
+- features/step_definitions/license-generator_steps.rb
+- features/support/env.rb
+- features/support/helpers.rb
+- spec/app_spec.rb
+- spec/spec_helper.rb