yaml_b_sides 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf46816b3a78fe32bad41dc0fbcd5ee4d2642a01
-  data.tar.gz: 24afd605cc2e41eef4a33a00db9c0fd3e3a34454
+  metadata.gz: 290831d7f1b375fdc3677f8482747c435028ac5f
+  data.tar.gz: 8ee7a67ada8164e8bbdbeb53fae5e49b9fc99f5c
 SHA512:
-  metadata.gz: d8360db9e42b671111ab15622a2118aee1fd88f5b48dc6d68cbaab424546eacb17b8e290f0cf69916e2b7d1c44dcef8ef1798e62e778fd76f02878ed9511d52a
-  data.tar.gz: 203d882c552eb01904ee6c2029d1e38d419dce056d23da6626bef28c656626cceb0ac0f371d7136168db09bf36cd0226c5963b714fdbcb3d8a7298d373917ae4
+  metadata.gz: a9e7b2bd03c35870aec5feb6ba9a42ffd79a139f05969a79b8a6f58d9454928261c139dec9a40289a1fe9e75c3855823b9ecc3d5f3046e37b1525d9d48992118
+  data.tar.gz: 9066c18974a19653f8adb232a53daea75ce2dcceb26a6c88b9eb3e14c67bd7871e6e7841555852277d8a16f8625104fb49c4c51cd3978f22addf9590c29c2a6e

data/README.md

@@ -64,6 +64,18 @@ These are completely optional, but if you have a yaml file that's not uniform, a
 * `property( name, defaul= nil )` : will set a single field. will set defaul value to nil if omitted
 * `properties( props = {})` : takes a hash; will set many defaults at once
 
+### Associations
+
+You can define simple associations that behave very much like ActiveRecord associations. Once you define your association, you will have a method with that name that will do the lookups and cache the results for you.
+
+* `belongs_to association`: the base object has to have the association id
+  * will return a single object or nil
+* `has_one`: the assiociation object has the id of the base. 
+  * will return a single object or nil
+* `has_many`: the association object has the id of the base.
+  * will return an array
+
+
 ### Example
 
 To use the `People` class from earlier, a fully fleshed out model would look something like:
@@ -74,11 +86,34 @@ class Person < YamlBSides::Base
   properties url_slug: "",
              bio: ""
 
+  has_many :nicknames
+
   index :name
   index :url_slug
 end
+
+class Nickname < YamlBSides::Base
+  belongs_to :person
+end
+
+```
+
+and the YAML files will look like
+
+```yml
+# in people.yml
+mark_twain:
+  name: Mark Twain
+  url_slug: mark-twain
+  #...
+
+# in nicknames.yml
+sam_clemmens:
+  name: Samuel Clemmens
+  person_id: mark_twain
 ```
 
+
 ## Setup
 
 The setup is pretty straightforward. Yaml B-Sides wants a logger and a base dir to look for files in. An example config for a Rails app would look like:

data/lib/yaml_b_sides.rb

@@ -8,6 +8,8 @@ require 'active_support/core_ext/hash'
 require 'yaml'
 
 module YamlBSides
+  autoload :Associatable,   'yaml_b_sides/associatable'
+  autoload :Associations,   'yaml_b_sides/associations'
   autoload :Base,           'yaml_b_sides/base'
   autoload :Cacheable,      'yaml_b_sides/cacheable'
   autoload :Instanceable,   'yaml_b_sides/instanceable'

data/lib/yaml_b_sides/associatable.rb

@@ -0,0 +1,51 @@
+module YamlBSides
+  module Associatable
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :__associations
+      self.__associations = {}
+
+      attr_accessor :_cached_associations
+
+      class << self
+
+        def belongs_to( name, opts = {} )
+          process Associations::BelongsTo.new( self, name, opts )
+        end
+
+        def has_one( name, opts = {} )
+          process Associations::HasOne.new( self, name, opts )
+        end
+
+        def has_many( name, opts = {} )
+          process Associations::HasMany.new( self, name, opts )
+        end
+        
+        protected
+
+        def process( association )
+          associate association
+          methodize association
+        end
+
+        def associate( association )
+          self.__associations = __associations.merge association.name => association
+        end
+
+        def methodize( association )
+          define_method association.name do 
+            self._cached_associations ||= {}
+
+            unless self._cached_associations.has_key? association.name
+              result = association.klass.send( association.action, association.query( self ) )
+              
+              self._cached_associations[association.name] = result
+            end
+            self._cached_associations[association.name]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yaml_b_sides/associations.rb

@@ -0,0 +1,8 @@
+module YamlBSides
+  module Associations
+    autoload :Base,       'yaml_b_sides/associations/base'
+    autoload :BelongsTo,  'yaml_b_sides/associations/belongs_to'
+    autoload :HasMany,    'yaml_b_sides/associations/has_many'
+    autoload :HasOne,     'yaml_b_sides/associations/has_one'
+  end
+end

data/lib/yaml_b_sides/associations/base.rb

@@ -0,0 +1,33 @@
+module YamlBSides
+  module Associations
+    class Base
+
+      attr_accessor :name, :opts, :key
+
+      def initialize( base_class, name, opts = {} )
+        self.name = name
+        self.opts = opts
+        self.key  = "#{base_class.to_s.demodulize.underscore}_id" 
+      end
+
+      def klass
+        @klass ||= association_class name, opts
+      end
+
+      protected
+
+      def association_class( name, opts = {} )
+        a_class       = opts[:class]                   if opts.has_key? :class
+        a_class_name  = opts[:class_name].constantize  if opts.has_key? :class_name
+        derived_class = derived_class_for name
+
+        a_class || a_class_name || derived_class
+      end
+
+      def derived_class_for( name )
+        name.to_s.singularize.classify.constantize
+      end
+
+    end
+  end
+end

data/lib/yaml_b_sides/associations/belongs_to.rb

@@ -0,0 +1,13 @@
+module YamlBSides
+  module Associations
+    class BelongsTo < Base
+      def action
+        :find
+      end
+
+      def query( instance )
+        instance.send "#{name}_id"
+      end
+    end
+  end
+end

data/lib/yaml_b_sides/associations/has_many.rb

@@ -0,0 +1,13 @@
+module YamlBSides
+  module Associations
+    class HasMany < Base
+      def action
+        :where
+      end
+
+      def query( instance )
+        { key => instance.id }
+      end
+    end
+  end
+end

data/lib/yaml_b_sides/associations/has_one.rb

@@ -0,0 +1,13 @@
+module YamlBSides
+  module Associations
+    class HasOne < Base
+      def action
+        :find_by
+      end
+
+      def query( instance )
+        { key => instance.id }
+      end
+    end
+  end
+end

data/lib/yaml_b_sides/base.rb

@@ -1,6 +1,7 @@
 module YamlBSides
   class Base
     include ActiveModel::Model
+    include Associatable
     include Cacheable
     include Propertiable
     include Indexable
@@ -15,7 +16,9 @@ module YamlBSides
       def load!
         @data = YAML.load_file( data_file ).with_indifferent_access
         idify_data!
-        puts "#{self} successfully loaded data"
+        logger.info "#{self} successfully loaded data"
+        # let's preemptively index by id so that when we do a find_by id:, or a where id: it won't table scan
+        index :id
       rescue => e
         logger.error "#{self} failed to load data: #{e}"
       end

data/lib/yaml_b_sides/indexable.rb

@@ -4,7 +4,7 @@ module YamlBSides
 
     included do
       class_attribute :__indices
-      self.__indices = {}
+      self.__indices = { }
 
       class << self
         def index(field)
@@ -28,7 +28,6 @@ module YamlBSides
         def index_for(field)
           __indices[field]
         end
-
       end
     end
   end

data/lib/yaml_b_sides/queriable.rb

@@ -11,13 +11,9 @@ module YamlBSides
         end
 
         def find_by(params = {})
-          if all_indexed?(params.keys)
-            results = find_by_indexed(params)
-          else
-            results = find_by_scan(params)
-          end
+          results = where params
           raise "Could not find record that matches: #{params.inspect}" if results.empty?
-          new results.first
+          results.first
         end
 
         def all
@@ -30,6 +26,18 @@ module YamlBSides
           new @data.values.first
         end
 
+        # TODO: move this into scopes
+        def where(params)
+          if all_indexed?(params.keys)
+            results = find_by_indexed(params)
+          else
+            results = find_by_scan(params)
+          end
+          results.map do |result|
+            new result
+          end
+        end
+
         private
 
         def find_by_scan(params)

data/lib/yaml_b_sides/version.rb

@@ -1,3 +1,3 @@
 module YamlBSides
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaml_b_sides
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Greg Orlov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-13 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -97,6 +97,12 @@ files:
 - bin/console
 - bin/setup
 - lib/yaml_b_sides.rb
+- lib/yaml_b_sides/associatable.rb
+- lib/yaml_b_sides/associations.rb
+- lib/yaml_b_sides/associations/base.rb
+- lib/yaml_b_sides/associations/belongs_to.rb
+- lib/yaml_b_sides/associations/has_many.rb
+- lib/yaml_b_sides/associations/has_one.rb
 - lib/yaml_b_sides/base.rb
 - lib/yaml_b_sides/cacheable.rb
 - lib/yaml_b_sides/index.rb