honor_codes 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in honor_codes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robbie Gill
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# HonorCodes
+
+Generate honor code style licences.
+
+The 'license' is entirely reversible and is not intended to protect from malicious use, but provides a nice generator
+and interpreter for creating non-directly editable licences or config files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'honor_codes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install honor_codes
+
+## Usage
+
+View the help with `bundle exec honor_codes` and `bundle exec honor_codes help <command>`
+
+## Contributing
+
+1. Fork it ( http://github.com/robbiegill/honor_codes/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/honor_codes

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+# Exit cleanly from an early interrupt
+Signal.trap("INT") { exit 1 }
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'honor_codes'
+require 'honor_codes/cli'
+
+HonorCodes::CLI.start(ARGV, :debug => true)

data/honor_codes.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'honor_codes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'honor_codes'
+  spec.version       = HonorCodes::VERSION
+  spec.authors       = ['Robbie Gill']
+  spec.email         = ['gill.rob@gmail.com']
+  spec.summary       = %q{Generate honor code style licences}
+  spec.homepage      = 'https://github.com/robbiegill/honor_codes'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = %w{honor_codes}
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w{lib}
+
+  spec.add_runtime_dependency 'thor', '~> 0.18.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0.0.beta1'
+end

data/lib/honor_codes/cli.rb

@@ -0,0 +1,44 @@
+require 'thor'
+require 'pp'
+require 'honor_codes'
+require 'honor_codes/generators/template'
+
+module HonorCodes
+  class CLI < Thor
+    package_name 'HonorCodes'
+
+    desc 'generate_from LICENSE_TEMPLATE [options]', 'generate license from LICENSE_TEMPLATE'
+    long_desc <<-LONGDESC
+Generates a simple license from a supplied yaml file. The resulting license will be dumped
+into the same directory as the LICENSE_TEMPLATE.
+    LONGDESC
+    method_option :filename, :default => HonorCodes::LICENSE_NAME, :aliases => '-f', :desc => 'sets the output filename'
+    method_option :print, :type => :boolean, :lazy_default => true, :aliases => '-p', :desc => 'prints the interpreted license'
+    def generate_from(template_path)
+      license_path = HonorCodes.generate template_path, options[:filename]
+      puts %Q(License stored to: #{license_path})
+      puts inspect license_path if options[:print]
+    end
+
+    desc 'inspect LICENSE_FILE', 'inspect LICENSE_FILE'
+    long_desc <<-LONGDESC
+Pretty prints the contents of the license.
+    LONGDESC
+    def inspect(license_path=HonorCodes::LICENSE_NAME)
+      puts HonorCodes.interpret license_path
+    end
+
+    desc 'template [option ...]', 'generate a license template.yml'
+    long_desc <<-LONGDESC
+Generate a license_template.yml file by providing space separated options
+
+option: key[:value[:type]] #types include int, date. If no type is supplied, the value will be a string
+
+Example:
+  honor_code template users:100:int vendor:my_company expires:2015-12-31:date
+    LONGDESC
+    def template(*fields)
+      HonorCodes::Generators::Template.start fields
+    end
+  end
+end

data/lib/honor_codes/core.rb

@@ -0,0 +1,80 @@
+require 'pathname'
+require 'yaml'
+require 'base64'
+
+module HonorCodes
+  LICENSE_NAME = 'honor_code.license'
+
+  def self.generate(template_path, filename)
+    Generator.new(template_path, filename).generate
+  end
+
+  def self.interpret(license_path)
+    Interpreter.new(license_path).interpret
+  end
+
+  def self.make_template(props)
+    TemplateMaker.new(props).make_template
+  end
+
+  class Generator
+    attr_accessor :template_path, :filename
+
+    def initialize(template_path, filename)
+      self.template_path = template_path
+      self.filename = filename
+    end
+
+    def generate
+      template = Pathname.new(template_path)
+      license = template.dirname.join(filename)
+      license.open('w') do |file|
+        file << Base64.encode64(template.read)
+      end
+      license.to_s
+    end
+  end
+
+  class Interpreter
+    attr_accessor :license_path
+
+    def initialize(license_path)
+      self.license_path = license_path
+    end
+
+    def interpret
+      license = Pathname.new license_path
+      YAML.load Base64.decode64(license.read)
+    end
+  end
+
+  class TemplateMaker
+    attr_accessor :props
+
+    def initialize(props)
+      self.props = props
+    end
+
+    def make_template
+      content = props.inject({}) do |memo, prop|
+        key, default, type = prop.split ':'
+        memo[key] = convert_type default, type
+        memo
+      end
+      YAML.dump :license => content
+    end
+
+    private
+
+    def convert_type(val, type)
+      case type
+        when /(int|integer)/
+          Integer(val)
+        when /(date)/
+          Date.parse(val)
+        else
+          val
+      end
+    end
+  end
+end

data/lib/honor_codes/generators/template.rb

@@ -0,0 +1,15 @@
+require 'thor/group'
+require 'yaml'
+
+module HonorCodes
+  module Generators
+    class Template < Thor::Group
+      include Thor::Actions
+
+      argument :properties, :type => :array
+      def write_template
+        create_file 'license_template.yml', HonorCodes.make_template(properties)
+      end
+    end
+  end
+end

data/lib/honor_codes/version.rb

@@ -0,0 +1,7 @@
+module HonorCodes
+  MAJOR         = 0
+  MINOR         = 1
+  PATCH         = 0
+
+  VERSION = [MAJOR, MINOR, PATCH].join('.')
+end

data/lib/honor_codes.rb

@@ -0,0 +1,6 @@
+require 'honor_codes/version'
+require 'honor_codes/core'
+
+module HonorCodes
+
+end

data/spec/honor_codes_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+require 'honor_codes'
+
+describe HonorCodes do
+  let(:license_template_dir) { Pathname.new '/tmp/spec/honor_codes' }
+  let(:license_template_path) { Pathname.new '/tmp/spec/honor_codes/license_template.yml' }
+  let(:license_template_content) do
+    <<-EOF
+top_level:
+  fixnum_key: #{fixnum_key}
+  date_key: #{date_key}
+  last_key: #{last_key}
+    EOF
+  end
+  let(:license_filename) { 'custom.file' }
+  let(:generated_license_pathname) { license_template_dir.join(license_filename) }
+
+  let(:fixnum_key) { 5 }
+  let(:date_key) { '2014-12-31' }
+  let(:last_key) { 'last_value' }
+
+  before do
+    FileUtils.rm_rf(license_template_dir)
+    FileUtils.mkdir_p(license_template_dir)
+    license_template_path.open('w') { |file| file << license_template_content }
+  end
+
+  describe '.generate' do
+    context 'when passed a yml file and output filename' do
+      before do
+        described_class.generate license_template_path.to_s, license_filename
+      end
+
+      it %Q{creates a #{HonorCodes::LICENSE_NAME} file in the same directory} do
+        expect(generated_license_pathname).to exist
+      end
+
+      it 'does not write pure yaml' do
+        license_content = generated_license_pathname.read
+        expect(YAML.load license_content).not_to eq(YAML.load license_template_content)
+      end
+    end
+  end
+
+  describe '.interpret' do
+    let(:result) { described_class.interpret generated_license_pathname.to_s }
+
+    before do
+      described_class.generate license_template_path.to_s, license_filename
+    end
+
+    context 'when passed a honor_code.license file' do
+      it 'reads the content into a license object with ruby types' do
+        expect(result).to eq(YAML.load license_template_content)
+        top_level = result['top_level']
+        expect(top_level['fixnum_key']).to be_a(Fixnum)
+        expect(top_level['last_key']).to eq(last_key)
+        expect(top_level['date_key']).to eq(Date.parse date_key)
+      end
+    end
+  end
+
+  describe '.make_template' do
+    let(:props) { %w( some_key:some_value other_key:100 ) }
+    let(:content) { described_class.make_template props }
+    let(:license_hash) { {'some_key' => 'some_value', 'other_key' => '100'} }
+    let(:expected) do
+      YAML.dump({:license => license_hash})
+    end
+
+    it 'splits elements on : and dumps yaml of the hash nested under :license' do
+      expect(content).to eq(expected)
+    end
+
+    context 'with data types' do
+      let(:props) { %w( int_key:1:integer string_key_type:val:string key_default_type:13 date_key:2014-12-31:date ) }
+      let(:license_hash) { {'int_key' => 1, 'string_key_type' => 'val', 'key_default_type' => '13', 'date_key' => Date.parse('2014-12-31')} }
+
+      it 'casts to the correct types in the yaml' do
+        expect(content).to eq(expected)
+      end
+
+      context 'loading the produced template' do
+        it 'is read with the same data types' do
+          read_license = YAML.load(content)[:license]
+          expect(read_license).to eq(license_hash)
+          expect(read_license['key_default_type']).to be_a(String)
+          expect(read_license['int_key']).to be_a(Fixnum)
+          expect(read_license['string_key_type']).to be_a(String)
+          expect(read_license['date_key']).to be_a(Date)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.tty = true
+  config.formatter = :documentation
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: honor_codes
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.1.0
+platform: ruby
+authors:
+- Robbie Gill
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+    none: false
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+    none: false
+  prerelease: false
+  type: :development
+description:
+email:
+- gill.rob@gmail.com
+executables:
+- honor_codes
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/honor_codes
+- honor_codes.gemspec
+- lib/honor_codes.rb
+- lib/honor_codes/cli.rb
+- lib/honor_codes/core.rb
+- lib/honor_codes/generators/template.rb
+- lib/honor_codes/version.rb
+- spec/honor_codes_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/robbiegill/honor_codes
+licenses:
+- MIT
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: !binary |-
+        MA==
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: !binary |-
+        MA==
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: Generate honor code style licences
+test_files:
+- spec/honor_codes_spec.rb
+- spec/spec_helper.rb