yolice 0.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'colorize'
+gem 'rake'

data/README.md

@@ -0,0 +1,21 @@
+#Yolice
+
+###Easy licensing for lazy people
+
+__DISCLAIMER__ - _I'm not a lawyer, and this gem is very simple. The aim is awareness, not to cover your ass._
+
+Just add the gem to your Gemfile:
+
+    gem 'yolice'
+
+Then you can run the rake tasks.
+
+###Tasks
+
+* List all licenses:
+
+      bundle exec rake licensing:list
+
+* Explain my rights and obligations:
+
+      bundle exec rake licensing:explain

data/Rakefile

@@ -0,0 +1,15 @@
+require './lib/yolice'
+
+namespace :licenses do
+
+  desc "List the licenses of your gems" 
+  task :list do
+    puts Yolice::YoLicense.new.raw_licenses
+  end
+
+  desc "Explain what licensing situation"
+  task :explain do
+    Yolice::YoLicense.new.match_licenses.col_features.print_explanations
+  end
+
+end

data/lib/licenses/license_features.yml

@@ -0,0 +1,302 @@
+---
+features:
+  include-copyright:
+    name: License and copyright notice 
+    required: Include a copy of the license and copyright notice with the code.
+  document-changes:
+    name: State Changes
+    required: Indicate significant changes made to the code.
+  disclose-source:
+    name: Disclose source
+    required: Source code must be made available when distributing the software. In the case of LGPL, the source for the library (and not the entire program) must be made available.
+  library-usage:
+    name: Library usage
+    permitted: The library may be used within a non-open-source application.
+  rename: 
+    name: 
+    required: You must change the name of the software if you modify it.
+  commercial-use:
+    name: Commercial use
+    permitted: This software and derivatives may be used for commercial purposes.
+  modifications:
+    name: Modification
+    permitted: This software may be modified.
+    forbidden: This software may not be modified.
+  distribution:
+    name: Distribution
+    permitted: You may distribute this software.
+    forbidden: You may not distribute this software.
+  sublicense:
+    name: Sublicensing
+    permitted: You may grant a sublicense to modify and distribute this software to third parties not included in the license.
+    forbidden: You may not grant a sublicense to modify and distribute this software to third parties not included in the license.
+  private-use:
+    name: Private use
+    permitted: You may use and modify the software without distributing it.
+  patent-grant:
+    name: Patent Grant
+    permitted: This license provides an express grant of patent rights from the contributor to the recipient.
+  trademark-use:
+    name: Use trademark
+    forbidden: While this may be implicitly true of all licenses, this license explicitly states that you may NOT use the names, logos, or trademarks of contributors.
+  no-liability:
+    name: Hold liable
+    forbidden: Software is provided without warranty and the software author/license owner cannot be held liable for damages.
+
+licenses:
+  gpl_2:
+    - feature: include-copyright
+      permission: required
+    - feature: document-changes
+      permission: required
+    - feature: disclose-source
+      permission: required
+    - feature: commercial-use
+      permission: permitted
+    - feature: modifications
+      permission: permitted
+    - feature: distribution
+      permission: permitted
+    - feature: patent-grant
+      permission: permitted
+    - feature: private-use
+      permission: permitted
+    - feature: no-liability
+      permission: forbidden
+    - feature: sublicense
+      permission: forbidden
+  apache_2:
+    - feature: include-copyright
+      permission: required
+    - feature: document-changes
+      permission: required
+    - feature: commercial-use
+      permission: permitted
+    - feature: modifications
+      permission: permitted
+    - feature: distribution
+      permission: permitted
+    - feature: patent-grant
+      permission: permitted
+    - feature: private-use
+      permission: permitted
+    - feature: no-liability
+      permission: forbidden
+    - feature: sublicense
+      permission: permitted
+    - feature: trademark-use
+      permission: forbidden
+  mit:
+    - feature: include-copyright
+      permission: required
+    - feature: commercial-use
+      permission: permitted
+    - feature: modifications
+      permission: permitted
+    - feature: distribution
+      permission: permitted
+    - feature: private-use
+      permission: permitted
+    - feature: no-liability
+      permission: forbidden
+    - feature: sublicense
+      permission: permitted
+  bsd_2_clause:
+    - feature: include-copyright
+      permission: required
+    - feature: commercial-use
+      permission: permitted
+    - feature: modifications
+      permission: permitted
+    - feature: distribution
+      permission: permitted
+    - feature: private-use
+      permission: permitted
+    - feature: no-liability
+      permission: forbidden
+    - feature: sublicense
+      permission: permitted
+  affero_gpl:
+    - feature: include-copyright
+      permission: required
+    - feature: document-changes
+      permission: required
+    - feature: disclose-source
+      permission: required
+    - feature: commercial-use
+      permission: permitted
+    - feature: modifications
+      permission: permitted
+    - feature: distribution
+      permission: permitted
+    - feature: private-use
+      permission: permitted
+    - feature: no-liability
+      permission: forbidden
+    - feature: sublicense
+      permission: forbidden
+  eclipse_v1:
+    - feature: include-copyright
+      permission: required
+    - feature: disclose-source
+      permission: required
+    - feature: commercial-use
+      permission: permitted
+    - feature: modifications
+      permission: permitted
+    - feature: distribution
+      permission: permitted
+    - feature: patent-grant
+      permission: permitted
+    - feature: private-use
+      permission: permitted
+    - feature: no-liability
+      permission: forbidden
+    - feature: sublicense
+      permission: permitted
+  public_domain:
+    - feature: commercial-use
+      permission: permitted
+    - feature: modifications
+      permission: permitted
+    - feature: distribution
+      permission: permitted
+    - feature: private-use
+      permission: permitted
+    - feature: no-liability
+      permission: forbidden
+    - feature: sublicense
+      permission: permitted
+  lgpl_3:
+    - feature: include-copyright
+      permission: required
+    - feature: disclose-source
+      permission: required
+    - feature: library-usage
+      permission: permitted
+    - feature: commercial-use
+      permission: permitted
+    - feature: modifications
+      permission: permitted
+    - feature: distribution
+      permission: permitted
+    - feature: patent-grant
+      permission: permitted
+    - feature: private-use
+      permission: permitted
+    - feature: no-liability
+      permission: forbidden
+    - feature: sublicense
+      permission: permitted
+  gpl_3:
+    - feature: include-copyright
+      permission: required
+    - feature: document-changes
+      permission: required
+    - feature: disclose-source
+      permission: required
+    - feature: commercial-use
+      permission: permitted
+    - feature: modifications
+      permission: permitted
+    - feature: distribution
+      permission: permitted
+    - feature: patent-grant
+      permission: permitted
+    - feature: private-use
+      permission: permitted
+    - feature: no-liability
+      permission: forbidden
+    - feature: sublicense
+      permission: forbidden
+  mozilla_2:
+    - feature: include-copyright
+      permission: required
+    - feature: disclose-source
+      permission: required
+    - feature: commercial-use
+      permission: permitted
+    - feature: modifications
+      permission: permitted
+    - feature: distribution
+      permission: permitted
+    - feature: patent-grant
+      permission: permitted
+    - feature: private-use
+      permission: permitted
+    - feature: no-liability
+      permission: forbidden
+    - feature: sublicense
+      permission: permitted
+    - feature: trademark-use
+      permission: forbidden
+  bsd_3_clause:
+    - feature: include-copyright
+      permission: required
+    - feature: commercial-use
+      permission: permitted
+    - feature: modifications
+      permission: permitted
+    - feature: distribution
+      permission: permitted
+    - feature: private-use
+      permission: permitted
+    - feature: no-liability
+      permission: forbidden
+    - feature: sublicense
+      permission: permitted
+    - feature: trademark-use
+      permission: forbidden
+  no-license:
+    - feature: include-copyright
+      permission: required
+    - feature: commercial-use
+      permission: permitted
+    - feature: private-use
+      permission: permitted
+    - feature: modifications
+      permission: forbidden
+    - feature: distribution
+      permission: forbidden
+    - feature: sublicense
+      permission: forbidden
+  lgpl_2_1:
+    - feature: include-copyright
+      permission: required
+    - feature: disclose-source
+      permission: required
+    - feature: library-usage
+      permission: permitted
+    - feature: commercial-use
+      permission: permitted
+    - feature: modifications
+      permission: permitted
+    - feature: distribution
+      permission: permitted
+    - feature: patent-grant
+      permission: permitted
+    - feature: private-use
+      permission: permitted
+    - feature: no-liability
+      permission: forbidden
+    - feature: sublicense
+      permission: permitted
+  artistic:
+    - feature: include-copyright
+      permission: required
+    - feature: document-changes
+      permission: required
+    - feature: commercial-use
+      permission: permitted
+    - feature: modifications
+      permission: permitted
+    - feature: distribution
+      permission: permitted
+    - feature: private-use
+      permission: permitted
+    - feature: no-liability
+      permission: forbidden
+    - feature: sublicense
+      permission: permitted
+    - feature: trademark-use
+      permission: forbidden

data/lib/yolice.rb

@@ -0,0 +1,133 @@
+require 'yaml'
+require 'ostruct'
+require 'colorize'
+
+class String
+  alias_method :forbidden, :red
+  alias_method :permitted, :green
+  alias_method :required, :yellow
+end
+
+module Yolice
+
+  class YoLicense
+    attr_reader   :license_features
+    attr_reader   :licenses
+    attr_reader   :raw_licenses
+    attr_reader   :features
+
+    def initialize
+      get_raw_licenses
+      @licenses = []
+      @features = {}
+      @license_features = OpenStruct.new.marshal_load(load_license_config)
+    end
+
+    def match_licenses
+      @raw_licenses.each do |gem_license|
+        @licenses << fetch_most_likely(compare_to_licenses(gem_license))
+      end
+      self
+    end
+
+    def col_features
+      @licenses.each do |l|
+        @license_features["licenses"][l].each do |f|
+          unless @features.include? f["feature"] && @features[f["feature"]] == "forbidden"
+            @features[f["feature"]] = f["permission"]
+          end
+        end
+      end
+      self
+    end
+
+    def print_explanations
+      puts "Here is your license situation: "
+      puts "=" * 20
+      @features.each do |f|
+        puts "#{@license_features["features"][f[0]]["name"]} - #{@license_features["features"][f[0]][f[1]]}".send f[1]
+      end
+    end
+
+    private
+      def load_license_config
+        YAML.load_file(File.join File.dirname(__FILE__), 'licenses', 'license_features.yml')
+      end
+
+      def get_raw_licenses
+        @raw_licenses = []
+        Gem::Specification.each do |g|
+          if g.licenses.count > 0
+            @raw_licenses << g.licenses 
+          end  
+        end
+        @raw_licenses.flatten!.uniq!
+      end
+
+      def preprocess_raw_license(raw_text)
+        raw_text.downcase.gsub(/[\.\-\s]/, "_")
+      end
+
+      def compare_to_licenses(gem_license)
+        map_results @license_features["licenses"].keys.map {|license_name| get_sorensen_index(preprocess_raw_license(gem_license), license_name)}
+      end
+
+      def get_sorensen_index(gem_license, license_name)
+        SorensenIndex.new(gem_license, license_name).calculate
+      end
+
+      def map_results(results)
+        Hash[@license_features["licenses"].keys.flatten.zip results]
+      end
+
+      def fetch_most_likely(result_hash)
+        result_hash.max_by {|k,v| v}[0]
+      end
+  end
+
+  class SorensenIndex
+    def initialize(*strings)
+      @bigram_sets = strings.map {|s| BigramSet.new(s)}
+    end
+
+    def calculate
+      2 * similarities.count / total.to_f
+    end
+
+    private
+      def similarities
+        @bigram_sets.first & @bigram_sets.last
+      end
+
+      def total
+        @bigram_sets.first.count + @bigram_sets.last.count
+      end
+  end
+
+  class BigramSet
+    attr_reader :bigrams
+
+    def initialize(string)
+      get_bigrams string.dup
+    end
+
+    def &(alt_set)
+      @bigrams & alt_set.bigrams
+    end
+
+    def count
+      @bigrams.count
+    end
+
+    private
+      def get_bigrams(str)
+        @bigrams = []
+        while str.length > 1 do
+          @bigrams << str[0..1] 
+          str[0] = ''
+        end
+      end
+  end
+
+end
+

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: yolice
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Andrew King
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-31 00:00:00.000000000 Z
+dependencies: []
+description: A lazy way to meet your licensing requirements.
+email: me@andrewsking.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- Gemfile
+- README.md
+- lib/yolice.rb
+- lib/licenses/license_features.yml
+homepage: http://rubygems.org/gems/yolice
+licenses:
+- MIT
+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: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Simple licensing
+test_files: []