traitorous 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0597d522d23bd2c71b7f3c32c4ba7051354855e9
+  data.tar.gz: 74bafa4cbd011ab8ab2e337a12d7f5c2294288b0
+SHA512:
+  metadata.gz: 4fd180776568fd37efb6663e4f2dc0635e58973dcd55d7803c7cec0680de77b50b811802897b1ae2e26a855727cfc7d513f764c2aeefd42b35f08f5ad864c685
+  data.tar.gz: c891627cf1985ec7be19f239c81d9e78bb99c5648678fffe063c9c1f26599d5aa9315f8f29766107a4a1bf6aba305f2a5434eafe74ec1b065663894b5c30cf96

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+before_install:
+- gem install bundler
+rvm:
+- 2.1
+- 2.2
+addons:
+  code_climate:
+    repo_token:
+      secure: kulnvpdGe7vQOyWXYJdCKesoAwhSGSPZUChh8mzxhOk6tedPtQ0CTC/FehWKdd/gyktgBVTn3OT/rqqsqVrOhOea7KQ5QpfvhZi8Yx7nlrw+zF/Z1eTPjCS+MNOpkJMLuXaC7PhmnJVzE2htjZ1Wca1lmOA+wl4ZiM5HtPlXKDagiEZjNGvTeRy0JqSQIXO991SbdV5WBXvNgPk3pUMNHRJjhD2rrmWkBI7ucsEpZfhKtMVbxYku52jOTnzm3PUe6hDXJ+SnOjc5wTgnYl9UdLbdUQAInUpyTRR5toRkSCqZ88wfYMqcWdITZatifZ8qrF91eX5I1HpExzRrui6r7xSYMNJ6Y/GGOhk1NOHwHx8SpxDk+lOciWWV0vlfrFCVF8C5hy8K8yE/5wPL5m7GgQguqhpTTfMhuRPw2ozcqczLxJKOKo5TqkeBm9frpFlKBOAydYB96rq9uRliEqchfPhDB4C8vbtpjpA9Z8GJdQZoJd4V4urZhxKwC8ItqB7acZrtZ/fgBiSM9+u2e/C7IBcWk9l7jKRW0jbsI1BFZy1MrbkbvS8xmIc+FxYU1CdNu0KXH5tCKrXoJxVTsLCUh/doOrSWfx30prkGVDyJQs6E0NIUPfywXjqQUlPtUgAd3PxWfCA9ZKY/Mug6qS6fdqowUBeUKk7fux9x5dAMAgk=

data/.travis.yml.orig

@@ -0,0 +1,9 @@
+language: ruby
+before_install:
+  - gem install bundler
+rvm:
+- 2.1
+- 2.2
+addons:
+  code_climate:
+    repo_token: secret_key_redacted

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in traitorous.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Guardfile

@@ -0,0 +1,23 @@
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec", all_after_pass: true, all_on_start: true  do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 scott m parrish
+
+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,104 @@
+# Traitorous
+
+[![Build Status](https://travis-ci.org/anithri/traitorous.svg)](https://travis-ci.org/anithri/traitorous)
+[![Code Climate](https://codeclimate.com/github/anithri/traitorous/badges/gpa.svg)](https://codeclimate.com/github/anithri/traitorous)
+
+This is a simple trait based system that emphasizes reading in and out data 
+structures, using an plugin Converter system.  Each trait defined has a 
+name and a Converter obj that responds to :export, and :import.
+  
+This process came out of a need to have a flexible config system that could be
+read from files easily (yaml, json, f*$k xml), populate a nested set of objects,
+and  able to export the while thing ready to be encoded and saved back to disk.
+
+The converters can be used to help (de)serialize, set default values, do 
+validations and translations.  The converter's job is to be able to import a 
+value, instantiating into classes and assigning values.  
+
+I took a lot of inspiration from [virtus](https://github.com/solnic/virtus).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'traitorous'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install traitorous
+
+## Usage
+
+```ruby
+
+# see spec/
+require 'traitorous'
+
+class Ruin
+  include Traitorous
+  include Traitorous::Equality
+  trait :name
+  trait :danger
+end
+
+r = Ruin.new(name: 'Skull Mountain', danger: 'The Devil of')
+#
+puts r.name
+# Skull Mountain
+
+puts r.danger
+# The Devil of
+
+puts r.export
+# {'name' => 'Skull Mountain, 'danger' => 'The Devil of'}
+
+puts Ruin.new(r.export) == r
+# true
+
+class Area
+  include Traitorous
+  include Traitorous::Equality
+  trait :name
+  trait :size, Converter::DefaultValueStatic.new('sub-continent')
+  trait :ruins, Converter::UniformArray.new(Ruin)
+end
+
+area = Area.new(
+  name: 'Western Marches',
+  size: 'Region',
+  ruins: [{name: 'Skull Mountain', danger: 'The Devil of'},
+          {name: 'Dire Swamp', danger: 'The Devil of'}
+          ]
+ )
+puts area.ruins.length
+# 2
+puts area.export
+#  {:name=>"Western Slope", :size=>"region", :ruins=>[{:name=>"Dire Swamp", :danger=>"The Creature of"}, {:name=>"Skull Mountain", :danger=>"The Devil of"}]}
+puts Area.new(area.export) == area
+# true
+```
+
+## Development
+
+I use Guard to automate testing.  It won't affect anything execpt the disk space
+needed to store the gems.  If you do want to use it, from a shell in the home
+directory of the gem and type `guard`.
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/traitorous/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+#require 'rake/version_task'
+require 'rspec/core/rake_task'
+
+#Rake::VersionTask.new
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default  => :spec
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "traitorous"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/traitorous/converter/default_value_static.rb

@@ -0,0 +1,15 @@
+module Traitorous
+  module Converter
+    class DefaultValueStatic
+      def initialize(default_value)
+        @default_value = default_value
+      end
+      def do_import(opts)
+        opts || @default_value
+      end
+      def do_export(data)
+        data
+      end
+    end
+  end
+end

data/lib/traitorous/converter/identity.rb

@@ -0,0 +1,13 @@
+module Traitorous
+  module Converter
+    class Identity
+      def do_export(data)
+        data
+      end
+
+      def do_import(opts)
+        opts
+      end
+    end
+  end
+end

data/lib/traitorous/converter/model.rb

@@ -0,0 +1,16 @@
+module Traitorous
+  module Converter
+    class Model
+      def initialize(model_klass)
+        @model_klass = model_klass
+      end
+      def do_import(opts)
+        @model_klass.new(opts)
+      end
+      def do_export(data)
+        data.export
+      end
+
+    end
+  end
+end

data/lib/traitorous/converter/uniform_array.rb

@@ -0,0 +1,17 @@
+module Traitorous
+  module Converter
+    class UniformArray
+      def initialize(uniform_class)
+        @uniform_class ||= uniform_class
+      end
+      def do_export(data_arr)
+        data_arr.map(&:export)
+      end
+
+      def do_import(opts_arr)
+        opts_arr.map{|d| @uniform_class.new(d)}
+      end
+
+    end
+  end
+end

data/lib/traitorous/equality.rb

@@ -0,0 +1,17 @@
+require 'traitorous'
+module Traitorous
+  module Equality
+    def ==(other_val)
+      traits.keys.all? do |trait_name|
+        orig_trait  =      self.send(trait_name.intern)
+        other_trait = other_val.send(trait_name.intern)
+        array_equality(orig_trait, other_trait) || (orig_trait == other_trait)
+      end
+    end
+
+    def array_equality(alpha, beta)
+      return false unless (alpha.is_a?(Array) && beta.is_a?(Array))
+      alpha.all?{|a| beta.any?{|b| a == b}}
+    end
+  end
+end

data/lib/traitorous.rb

@@ -0,0 +1,60 @@
+require 'active_support/core_ext/hash/indifferent_access'
+
+module Traitorous
+  HASH = HashWithIndifferentAccess
+
+  VERSION = File.read('VERSION')
+
+  module Converter
+    require 'traitorous/converter/identity'
+    require 'traitorous/converter/default_value_static'
+    require 'traitorous/converter/model'
+    require 'traitorous/converter/uniform_array'
+    DEFAULT_CONVERTER = Converter::Identity.new
+  end
+  require 'traitorous/equality'
+  module ClassMethods
+    attr_accessor :traits
+
+    def trait(attr_name, converter = Traitorous::Converter::DEFAULT_CONVERTER)
+      self.traits            ||= HASH.new
+      # sub hash used here, {} chosen for expansion possibility, but only
+      #   :converter is in use
+      self.traits[attr_name] = {converter: converter}
+      attr_accessor attr_name
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def initialize(opts = {})
+    @opts = HASH.new(opts)
+    traits.each_pair do |new_trait, trait_opts|
+      converter = trait_opts[:converter]
+      val = converter.do_import(@opts.fetch(new_trait, nil))
+      self.send("#{new_trait}=".intern, val)
+    end
+  end
+
+  def export
+    exported = HASH.new
+    traits.each_pair do |trait_name, trait_opts|
+      attr_value = self.public_send(trait_name.intern)
+      exported[trait_name] = trait_opts[:converter].do_export(attr_value)
+    end
+    exported
+  end
+
+  def traits
+    self.class.traits
+  end
+
+  def inspect
+    string = "#<#{self.class.name}:#{self.object_id} "
+    fields = self.class.traits.keys.map{|field| "#{field}: #{self.send(field).inspect}"}
+    string << fields.join(", ") << ">"
+  end
+
+end

data/traitorius.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'traitorous'
+  spec.version       = File.read('VERSION')
+  spec.authors       = ['scott m parrish']
+  spec.email         = ['anithri@gmail.com']
+
+  spec.summary       = %q{A simple attribute, import, export system for PORO, }
+  spec.description   = %q{This is a simple trait based system that emphasizes the ability to import and export from storage formats}
+  spec.homepage      = 'https://github.com/anithri/traitorous'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport'
+  spec.add_development_dependency 'version'
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'guard-rspec'
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: traitorous
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- scott m parrish
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is a simple trait based system that emphasizes the ability to import
+  and export from storage formats
+email:
+- anithri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".travis.yml.orig"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/console
+- bin/setup
+- lib/traitorous.rb
+- lib/traitorous/converter/default_value_static.rb
+- lib/traitorous/converter/identity.rb
+- lib/traitorous/converter/model.rb
+- lib/traitorous/converter/uniform_array.rb
+- lib/traitorous/equality.rb
+- traitorius.gemspec
+homepage: https://github.com/anithri/traitorous
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A simple attribute, import, export system for PORO,
+test_files: []