yaml_enumeration 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3b4ba65e62cb6d1cab8e1dff3e7bab95cda4e94
+  data.tar.gz: 74f6a30f937b96db97add1ed81db44b31045523d
+SHA512:
+  metadata.gz: 0a9501189bf47b9fe78c93d1b2020dfc614429be7eac9a93a49b3495d3930cca932ffbe11bff6e515a7d7092da1727c73c466abc43cbea10df2e2241e6f937d4
+  data.tar.gz: 6d0a83d915f6eeb99d1df80201c7a26c9145f7277880cece0f96f3a9955225d676828de8d7883ae16ce2b8cedbd1449e90efba1be5ce43481a90698a2b46b396

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at boettger@mt7.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Thorsten Böttger
+
+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,41 @@
+# YamlEnumeration
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yaml_enumeration`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yaml_enumeration'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yaml_enumeration
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yaml_enumeration. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yaml_enumeration"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/yaml_enumeration/association.rb

@@ -0,0 +1,23 @@
+module YamlEnumeration
+  module Association
+
+    def belongs_to_enumeration(enumeration, options={})
+      class_name = options[:class_name] ? options[:class_name] : enumeration
+
+      define_method(enumeration) do
+        local_instance = self.instance_variable_get("@#{enumeration}")
+        local_id = send("#{enumeration}_id")
+        if local_instance && local_instance.id == local_id
+          local_instance
+        else
+          self.instance_variable_set("@#{enumeration}", local_id && class_name.to_s.classify.constantize.find_by_id(local_id))
+        end
+      end
+
+      define_method("#{enumeration}=") do |instance|
+        send("#{enumeration}_id=", instance.try(:id))
+      end
+    end
+
+  end
+end

data/lib/yaml_enumeration/enumeration.rb

@@ -0,0 +1,106 @@
+require 'active_support/core_ext/class/attribute'
+
+module YamlEnumeration
+  class Enumeration
+
+    extend Association
+
+    class_attribute :values
+    class_attribute :attributes
+    class_attribute :all_instances
+
+    attr_accessor :id
+
+    def self.load_values(filename)
+      file = File.join(Rails.root, 'db', 'enumerations', "#{filename}.yml")
+      YAML.load(ERB.new(File.read(file)).result).values.each do |data|
+        value data.symbolize_keys
+      end
+    end
+
+    def self.value(hash)
+      unless hash.key?(:id) && hash.key?(:type)
+        raise "invalid definition"
+      end
+
+      self.attributes ||= Set.new
+      self.attributes += hash.keys
+
+      hash.keys.each do |attr|
+        # defining getter method
+        unless method_defined?(attr)
+          define_method attr do
+            self.class.values[id][attr]
+          end
+        end
+        # defining question method
+        unless method_defined?("#{attr}?")
+          define_method "#{attr}?" do
+            !!self.class.values[id][attr]
+          end
+        end
+        # defining setter method
+        unless method_defined?("#{attr}=")
+          define_method "#{attr}=" do |v|
+            self.class.values[id][attr] = v
+          end
+        end
+      end
+
+      self.values ||= {}
+      self.values[hash[:id]] = hash
+    end
+
+    # def method_missing(name, *args, &block)
+    #   if name[-1] == '=' && self.class.attributes.include?(name[0..-2].to_sym)
+    #     self.class.values[id][name[0..-2].to_sym] = args.pop
+    #   elsif name[-1] == '?' && self.class.attributes.include?(name[0..-2].to_sym)
+    #     !!self.class.values[id][name[0..-2].to_sym]
+    #   elsif self.class.attributes.include?(name.to_sym)
+    #     self.class.values[id][name.to_sym]
+    #   else
+    #     super
+    #   end
+    # end
+
+    def ==(other)
+      other && id == other.id
+    end
+
+    def to_s
+      "#{self.class}(#{self.class.values[id].inspect})"
+    end
+
+    class << self
+      def all
+        # values.keys.map {|id| new(id)} # override this if you do not want to keep associated obj loaded against
+        self.all_instances ||= values.keys.map {|id| new(id)}
+      end
+
+      def find(id)
+        case id
+          when Integer
+            all.detect {|a| a.id == id}
+          when NilClass
+            nil
+          else
+            all.detect {|a| a.type == id.to_s}
+        end
+      end
+      alias_method :find_by_id, :find
+
+      def find_by_type(type)
+        all.detect {|a| a.type == type.to_s}
+      end
+
+      protected :new
+    end # class << self
+
+    private
+
+    def initialize(id)
+      self.id = id
+    end
+
+  end # Enumeration
+end

data/lib/yaml_enumeration/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails/railtie'
+
+module YamlEnumeration
+  class Railtie < Rails::Railtie
+    initializer "extending ActiveRecord with YamlEnumeration" do
+      ActiveRecord::Base.extend(YamlEnumeration::Association)
+    end
+  end
+end

data/lib/yaml_enumeration/version.rb

@@ -0,0 +1,3 @@
+module YamlEnumeration
+  VERSION = "0.1.0"
+end

data/lib/yaml_enumeration.rb

@@ -0,0 +1,4 @@
+require "yaml_enumeration/version"
+require "yaml_enumeration/association"
+require "yaml_enumeration/enumeration"
+require "yaml_enumeration/railtie"

data/yaml_enumeration.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yaml_enumeration/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yaml_enumeration"
+  spec.version       = YamlEnumeration::VERSION
+  spec.authors       = ["Thorsten Boettger"]
+  spec.email         = ["boettger@mt7.de"]
+
+  spec.summary       = %q{Create ActiveRecord enumerations based on YAML files.}
+  spec.description   = %q{Create ActiveRecord enumerations based on YAML files.}
+  spec.homepage      = "https://github.com/alto/yaml_enumeration"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "shoulda-context"
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "railties"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: yaml_enumeration
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thorsten Boettger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  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: shoulda-context
+  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: 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: railties
+  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'
+description: Create ActiveRecord enumerations based on YAML files.
+email:
+- boettger@mt7.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yaml_enumeration.rb
+- lib/yaml_enumeration/association.rb
+- lib/yaml_enumeration/enumeration.rb
+- lib/yaml_enumeration/railtie.rb
+- lib/yaml_enumeration/version.rb
+- yaml_enumeration.gemspec
+homepage: https://github.com/alto/yaml_enumeration
+licenses:
+- MIT
+metadata: {}
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Create ActiveRecord enumerations based on YAML files.
+test_files: []