static_collection 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6199b4a21a4295980ea842bb4bce5d4b79b83af3
-  data.tar.gz: 75e0bc003f13bd5e4eb521dc93ed03860488334c
+SHA256:
+  metadata.gz: aee7a2335834e9e570ff2bc0e0289c33babb47131cfbba9a7e99f23d117f7583
+  data.tar.gz: 26d5d69190b140785b8355e45c99cdcc0de4173e380ce8b195d8fab56ee5ed23
 SHA512:
-  metadata.gz: fa8b41e1d4b23351d3bb1e810a1acf4e495ed9bdd19bbf088e9f9e3fc9940af043284ce455605757c5cea7813e7b0619c8e1ba1dd47a5c86e84212e65a85e8f0
-  data.tar.gz: 145d67ebebb03c43e7cf985116290494343a579682ffecca5171c3286ea3815b6023cfdb691db5a2aecefc9241c123433280ba5572df5b43e3050e54f7efb16d
+  metadata.gz: bd6b84129218e0a98310d745aab5ef54e8a6ef5c14f868acb3dcc4a0d0aa701f5897f2e760a4beb4471960f393b1dc4e34303e13939799eb217a3cb4d567b9f5
+  data.tar.gz: d2c325572a184526e2fde0a1e89f6d85bd7c074ccbc42826b82af5b804c8f79eda390e5e0b16d2670ffbd5bb8596b414720d73f8eef8ce2c5899e38cd2ab8b9d

data/.gitignore

@@ -10,3 +10,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+*.gem

data/.ruby-version

@@ -1 +1 @@
-2.3.3
+2.5.1

data/README.md

@@ -1,6 +1,6 @@
-# StaticCollection [![CircleCI](https://circleci.com/gh/wealthsimple/static_collection.svg?style=svg)](https://circleci.com/gh/wealthsimple/static_collection)
+# StaticCollection [![CircleCI](https://circleci.com/gh/wealthsimple/static_collection.svg?style=svg)](https://circleci.com/gh/wealthsimple/static_collection) [![](https://img.shields.io/gem/v/static_collection.svg)](https://rubygems.org/gems/static_collection)
 
-Rubygem for running basic queries against static YAML data.
+Rubygem for running basic queries against static data.
 
 ## Installation
 
@@ -20,7 +20,37 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To create a StaticCollection model, inherit from `StaticCollection::Base`
+
+```ruby
+class AccountType < StaticCollection::Base
+end
+```
+
+Then set the source for the static collection data. To read from YAML,
+
+```ruby
+class AccountType < StaticCollection::Base
+  set_source YAML.load_file('./data/account_types_test.yml')
+end
+```
+
+To set a default value for an attribute, pass a defaults hash into `set_source`
+
+```ruby
+class AccountType < StaticCollection::Base
+  set_source YAML.load_file('./data/account_types_test.yml'), defaults: { recommended_by_default: false }
+end
+```
+
+StaticCollection supports the following query methods: `:count`, `:all`, `:find_by`, and `:where`.
+
+```ruby
+> AccountType.find_by(type: 'joint').ownership_type
+=> "multi-owner"
+```
+
+To see the full `AccountType` example, take a look at our [blog post](http://code.wealthsimple.com/introducing-staticcollection-an-activerecord-interface-for-static-data/).
 
 ## Development
 

data/lib/static_collection.rb

@@ -12,9 +12,11 @@ module StaticCollection
       all.first.attributes.each do |attribute_name, attribute_value|
         # Class methods
         self.define_singleton_method("find_by_#{attribute_name}") do |value|
+          ActiveSupport::Deprecation.warn("find_by_#{attribute_name} is deprecated for StaticCollection, use find_by(#{attribute_name}: [value])")
           all.find { |instance| instance.send(attribute_name) == value }
         end
         self.define_singleton_method("find_all_by_#{attribute_name}") do |value|
+          ActiveSupport::Deprecation.warn("find_all_by_#{attribute_name} is deprecated for StaticCollection, use where(#{attribute_name}: [value])")
           all.select { |instance| instance.send(attribute_name) == value }
         end
 
@@ -24,6 +26,14 @@ module StaticCollection
       end
     end
 
+    def self.find_by(opts)
+      all.find { |instance| opts.all? { |k, v| instance.send(k) == v } }
+    end
+
+    def self.where(opts)
+      all.select { |instance| opts.all? { |k, v| instance.send(k) == v } }
+    end
+
     def self.all
       defaults = self.class_variable_get(:@@defaults)
       self.class_variable_get(:@@source).map { |s| self.new(defaults.merge(s)) }

data/lib/static_collection/version.rb

@@ -1,3 +1,3 @@
 module StaticCollection
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/static_collection.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Peter Graham"]
   spec.email         = ["peter@wealthsimple.com"]
 
-  spec.summary       = %q{Run queries against static YAML data.}
-  spec.description   = %q{Rubygem for running basic queries against static YAML data.}
+  spec.summary       = %q{Run queries against static data.}
+  spec.description   = %q{Rubygem for running basic queries against static data.}
   spec.homepage      = "https://github.com/wealthsimple/static_collection"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: static_collection
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Peter Graham
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-24 00:00:00.000000000 Z
+date: 2018-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-description: Rubygem for running basic queries against static YAML data.
+description: Rubygem for running basic queries against static data.
 email:
 - peter@wealthsimple.com
 executables: []
@@ -90,7 +90,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -120,8 +119,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Run queries against static YAML data.
+summary: Run queries against static data.
 test_files: []

data/.travis.yml

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