yaml_enumeration 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d3b4ba65e62cb6d1cab8e1dff3e7bab95cda4e94
-  data.tar.gz: 74f6a30f937b96db97add1ed81db44b31045523d
+SHA256:
+  metadata.gz: 329c035e5c90f7cd2c444c1237f2c1c5bf00b50ae6cefcf6f8658c1cdda7fe45
+  data.tar.gz: debf948e5a235157517ef21d67c6d498f3d2a623cfc9cbe384ae7d81dc8ed05f
 SHA512:
-  metadata.gz: 0a9501189bf47b9fe78c93d1b2020dfc614429be7eac9a93a49b3495d3930cca932ffbe11bff6e515a7d7092da1727c73c466abc43cbea10df2e2241e6f937d4
-  data.tar.gz: 6d0a83d915f6eeb99d1df80201c7a26c9145f7277880cece0f96f3a9955225d676828de8d7883ae16ce2b8cedbd1449e90efba1be5ce43481a90698a2b46b396
+  metadata.gz: 730bdbbefa4291935287eda1f56d78cf5f4e4c349426caf4fc20597fdb2cf43d1a627300031a45716dc57b7ecd60c4453de7ee9bb47f76341c19d908d4332a36
+  data.tar.gz: 8b75285fa43d9440d635566104d5201f8a8192d58d4754c69c134470e8e348456e1b38519aea3b74b9be33fa0a93effd5872566e0d7f2257c86bb5f15c5e16fa

data/.travis.yml

@@ -1,5 +1,7 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.12.5
+  - 2.5.3
+  - 2.6.5
+  - 2.7.1
+before_install: gem install bundler

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# CHANGELOG
+
+## 0.3.0
+ * enable exclusion of blocks of YAML from the enumeration (support YAML anchors) [#6](https://github.com/alto/yaml_enumeration/pull/6)
+
+## 0.2.2
+ * enhance find-by methods [#4](https://github.com/alto/yaml_enumeration/pull/4)
+ * add support for Ruby `2.6` and `2.7` [#3](https://github.com/alto/yaml_enumeration/pull/3)
+
+## 0.2.1
+ * add support for Ruby `2.5.3` [#2](https://github.com/alto/yaml_enumeration/pull/2)
+
+## 0.2.0
+ * support _ActiveRecord_ methods `where`, `find_by` [#1](https://github.com/alto/yaml_enumeration/pull/1), thanks to [@richdrich](https://github.com/richdrich)
+
+## 0.1.0
+ * initial version

data/README.md

@@ -1,12 +1,17 @@
-# YamlEnumeration
+# Yaml Enumeration
 
-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.
+[![Gem Version](https://badge.fury.io/rb/yaml_enumeration.svg)](http://badge.fury.io/rb/yaml_enumeration)
+[![Build Status](https://travis-ci.org/alto/yaml_enumeration.svg?branch=master)](https://travis-ci.org/alto/yaml_enumeration)
 
-TODO: Delete this and the text above, and describe your gem
+Create classes which work (a bit) like
+[ActiveRecord](http://guides.rubyonrails.org/active_record_basics.html)
+classes, but are defined as fixed enumerations based on
+[YAML](http://yaml.org)
+files.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
 ```ruby
 gem 'yaml_enumeration'
@@ -22,7 +27,98 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Let's assume you have a `User` class representing a user who can log into your app.
+This user is supposed to have a home country, and you want to do things like
+
+```ruby
+user = User.new(country: Country.find_by_code('nz'))
+puts user.country.code
+# => 'nz'
+puts user.country.name
+# => 'New Zealand'
+```
+
+You can then simply create a `Country` class:
+
+```ruby
+# country.rb
+class Country < YamlEnumeration::Enumeration
+  # imports the definitions from the yaml file countries.yml
+  load_values :countries
+
+  # all, where, find_by and find_by_type are provided
+  def self.find_by_code(code)
+    all.find_by(code: code)
+  end
+end
+```
+
+a `yaml` file containing all your countries:
+
+```yaml
+# countries.yml
+---
+nz:
+  id: 1 # has to be provided
+  type: new_zealand # has to be provided
+  name: New Zealand
+  code: nz
+au:
+  id: 2
+  type: australia
+  name: Australia
+  code: au
+...
+```
+
+and link that into your `User` class:
+
+```ruby
+# user.rb
+class User < ActiveRecord::Base
+  belongs_to_enumeration :country
+end
+```
+
+additional `yaml` syntax such as anchors can be removed from the enumeration by including `_exclude_from_enumeration`:
+
+```yaml
+# countries.yml
+---
+defaults_exclude_from_enumeration: &defaults
+  continent: Australia
+
+nz:
+  <<: *defaults
+  id: 1 # has to be provided
+  type: new_zealand # has to be provided
+  name: New Zealand
+  code: nz
+au:
+  <<: *defaults
+  id: 2
+  type: australia
+  name: Australia
+  code: au
+uk:
+  <<: *defaults
+  id: 3
+  type: united_kingdom
+  name: United Kingdom
+  code: uk
+  continent: Europe
+...
+```
+
+## Accessing members
+
+If you include a call to class method `with_named_items` you will get an item defined for each typed entry in the enumeration, e.g. `Country.NEW_ZEALAND` and `Country.AUSTRALIA`.
+
+By passing a column name, e.g:
+```
+with_named_items(:code)
+```
+that column will be used, e.g: `Country.AU` and `Country.NZ` 
 
 ## Development
 
@@ -32,10 +128,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/alto/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/lib/yaml_enumeration/enumeration.rb

@@ -13,7 +13,7 @@ module YamlEnumeration
 
     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|
+      remove_exclusions(YAML.load(ERB.new(File.read(file)).result)).values.each do |data|
         value data.symbolize_keys
       end
     end
@@ -73,6 +73,7 @@ module YamlEnumeration
 
     class << self
       def all
+        return [] unless values
         # 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
@@ -89,10 +90,51 @@ module YamlEnumeration
       end
       alias_method :find_by_id, :find
 
+      def find_by(column, value=nil)
+        case column
+        when Hash
+          raise "Hashes with multiple filters are not support so far" if column.keys.size > 1
+
+          key = column.keys[0]
+          all.find {|item| item.send(key) == column[key] }
+        else
+          all.find {|item| item.send(column) == value }
+        end
+      end
+
+      def find_all_by(column, value=nil)
+        case column
+        when Hash
+          raise "Hashes with multiple filters are not support so far" if column.keys.size > 1
+
+          key = column.keys[0]
+          all.select {|item| item.send(key) == column[key] }
+        else
+          all.select {|item| item.send(column) == value }
+        end
+      end
+
       def find_by_type(type)
         all.detect {|a| a.type == type.to_s}
       end
 
+      def where(matches)
+        raise "Only the hash form of where is supported, not #{matches}" unless matches.is_a?(Hash)
+
+        all.select do |item|
+          matches.all? {|k,v| item.send(k) == v }
+        end
+      end
+
+      # Define singleton methods .BLAH for each type
+      def with_named_items(column = :type)
+        all.each do |item|
+          define_singleton_method "#{item.send(column).upcase}" do
+            find_by(column, item.send(column).downcase)
+          end
+        end
+      end
+
       protected :new
     end # class << self
 
@@ -102,5 +144,10 @@ module YamlEnumeration
       self.id = id
     end
 
+    def self.remove_exclusions(result)
+      keys_to_remove = result.keys.select {|key| key =~ /.*_exclude_from_enumeration$/ }
+      result.except(*keys_to_remove)
+    end
+
   end # Enumeration
 end

data/lib/yaml_enumeration/version.rb

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

data/yaml_enumeration.gemspec

@@ -10,7 +10,8 @@ Gem::Specification.new do |spec|
   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.description   = %q{Create classes which work like ActiveRecord classes,
+                          but are defined as fixed enumerations based on YAML files.}
   spec.homepage      = "https://github.com/alto/yaml_enumeration"
   spec.license       = "MIT"
 
@@ -19,11 +20,11 @@ Gem::Specification.new do |spec|
   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 "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "maxitest"
   spec.add_development_dependency "shoulda-context"
 
-  spec.add_dependency "activesupport"
-  spec.add_dependency "railties"
+  spec.add_dependency "activesupport", '>= 6'
+  spec.add_dependency "railties", '>= 6'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: yaml_enumeration
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Thorsten Boettger
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-08-05 00:00:00.000000000 Z
+date: 2022-02-03 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'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: maxitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -72,29 +72,31 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
   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.
+        version: '6'
+description: |-
+  Create classes which work like ActiveRecord classes,
+                            but are defined as fixed enumerations based on YAML files.
 email:
 - boettger@mt7.de
 executables: []
@@ -103,6 +105,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -120,7 +123,7 @@ homepage: https://github.com/alto/yaml_enumeration
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -135,9 +138,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.2.17
+signing_key:
 specification_version: 4
 summary: Create ActiveRecord enumerations based on YAML files.
 test_files: []