Easily generate software licenses.
Ruby HTML
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
data
lib
spec
templates
.gitignore
.rspec
.rubocop.yml
.yardopts
Gemfile
Guardfile
LICENSE
README.md
Rakefile
licenses.gemspec

README.md

Licenses

Create software licenses easily.

Install

Bundler: gem 'licenses'

RubyGems: gem install licenses

Usage

Creating

Simple

license = Licenses::MIT.new do |l|
  l.year.start   = 2010
  l.author.name  = 'Ryan Scott Lewis'
  l.author.email = 'ryan@rynet.us'
end

p license.to_s # => "Copyright (c) 2010-2012 Ryan Scott Lewis <ryan@rynet.us>\n\nPermission is hereby granted, free of charge..."
Multiple Authors
license = Licenses::MIT.new do |l|
  l.year.start  2010
  l.authors.add name: 'Ryan Scott Lewis', email: 'ryan@rynet.us'
  l.authors.add name: 'John Doe', email: 'john.doe@example.com'
  l.authors.add name: 'Snake Pliskin'
  l.authors.add 'John McClane <john@mcclain.org, jmcclane@gmail.com>'
end

p license.to_s                # => "Copyright (c) 2010-2012 Ryan Scott Lewis <ryan@rynet.us>, John Doe <john.doe@example.com>\n\nPermission is hereby granted, free of charge..."
p license.authors.first.name  # => 'Ryan Scott Lewis'
p license.authors.first.email # => 'ryan@rynet.us'
p license.authors.last.name   # => 'John McClane'
p license.authors.last.email  # => ['john@mcclain.org', 'jmcclane@gmail.com]
Smart Setters
license = Licenses::License.new do |l|
  l.type    License::MIT # Set which type of license here instead
  l.year    '2006-2011'  # Will set year.start to 2006 and year.end to 2011
  l.authors 'Ryan Scott Lewis<ryan@rynet>, John Doe     <    john.doe@example.com   >' 
end

p license.to_s # => "Copyright (c) 2006-2012 Ryan Scott Lewis <ryan@rynet.us>, John Doe <john.doe@example.com>\n\nPermission is hereby granted, free of charge..."
Advanced

Note: This is the preferred method.

Do not pass block variables to enter the scope of the License.

license = Licenses::License.new do
  type   MIT
  year   2010..2012
  author 'Ryan Scott Lewis <ryan@rynet.us>'
end

p license.to_s # => "Copyright (c) 2010-2012 Ryan Scott Lewis <ryan@rynet.us>\n\nPermission is hereby granted, free of charge..."

Todo

Parsing

require 'licenses'

license_str = "Copyright (c) 2010-2012 Ryan Scott Lewis <ryan@rynet.us>\n\nPermission is hereby granted, free of charge...the rest of the MIT license here..."
license = Licenses.parse(license_str)

p license.class               # => Licenses::MIT
p license.type                # => :mit
p license.name                # => 'MIT License'
p license.year.start          # => 2010
p license.year.end            # => 2012
p license.authors.first.name  # => 'Ryan Scott Lewis'
p license.authors.first.email # => 'ryan@rynet.us'

Contributing

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
  • Fork the project
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright © 2012 Ryan Scott Lewis ryan@rynet.us.

The MIT License (MIT) - See LICENSE for further details.