yaml_b_sides 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34f0e2100b8e81fce8b87d1dba72fcb86f9fb793
-  data.tar.gz: 5bc09894491c3d319201395b7e2b8db587bf41bc
+  metadata.gz: 74424ddac245862a30ea744f4287c97c172890fb
+  data.tar.gz: 42c2edbd0cf88620f71b22405604c4c80a8a28d7
 SHA512:
-  metadata.gz: 1eac6dbbeab847afcc4a1e8b13928b136eea401944cc4cd6e5565d2a4e498e318eb91088adb9c361a8c45564c0704a3e9c395ee2e58691fc5150ed8113873819
-  data.tar.gz: fb58598b0988436f4a87c745e113465d08a745ce0b6d8fcd2bad47629b089c69a0f84057150ece185daf133a7ee8d864e446aa40642ba5ee653fd328dcf5a545
+  metadata.gz: cc05aaea7469a14f9cd9e8cdc06eeb3359337a340ef72396684ed5bc573a9fe07f2175c452c0ad238aa0c2c4bf6dd8593d51d7dd908e72a4e21637dcf6d0110e
+  data.tar.gz: 5726358d0660a9b48e479f23c747beb51e14a4999ab662613bf169c454862c1b4307159409af3b69721c72b05f9036f0f9d44b32012e5251529854fee7bf17ec

data/README.md

@@ -1,8 +1,6 @@
-# YamlBSides
+# Yaml B-Sides
 
-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_b_sides`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+`YamlBSides` is a simple read-only implementation of [YamlRecord](https://github.com/nicotaing/yaml_record). It's designed for users whose data is perfectly static and is stored in yaml files.
 
 ## Installation
 
@@ -22,7 +20,73 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+`Yaml B-Sides` acts very mich like active record. You set up your base class like you would an ActiveRecord class:
+
+```ruby
+class Person < YamlBSides::Base
+```
+
+and your `#{FIXTURES_PATH}/people.yml` (see [Setup](#setup) for fixtures path setup):
+
+```yml
+greg:
+  name: Greg Orlov
+  url_slug: greg
+  bio: |
+    I do stuff
+
+john:
+  name: John Doe
+  # ... etc
+```
+
+and you're in business. Your `Person` objects will now respond to the *present* fields as methods. (see [Properties](#property-definitions) for setting defaults)
+
+Note: `Yaml B-Sides` expects your class names to match the fixture names (e.g. `Person` will want a `people.yml` file)
+
+Your `Person` class now responds to 
+
+### Query Methods
+
+* `all` : will give you all of the records in the table
+* `first` : wil return the first record in the table
+* `find( id )` : will find a single record with the specified yaml key
+* `find_by( properties = {} )` : will find all the recored that match all the proerties in the hash
+
+### Indexing
+
+* `index( field )` : will add an index on that field, for faster searching
+
+### Property definitions
+
+These are completely optional, but if you have a yaml file that's not uniform, and want to have some defaults, you can use
+
+* `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
+
+### Example
+
+To use the `People` class from earlier, a fully fleshed out model would look something like:
+
+```ruby
+class Person < YamlBSides::Base
+  property   :name, ""
+  properties url_slug: "",
+             bio: ""
+
+  index :name
+  index :url_slug
+end
+```
+
+## 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:
+
+```ruby
+YamlBSides::Base.logger = Rails.logger
+YamlBSides::Base.root_path = Rails.root.join 'db', 'fixtures'
+```
 
 ## Development
 

data/lib/yaml_b_sides/base.rb

@@ -3,6 +3,7 @@ module YamlBSides
     include ActiveModel::Model
     include Cacheable
     include Propertiable
+    include Indexable
     include Instanceable
     include Queriable
 
@@ -12,7 +13,6 @@ module YamlBSides
     class << self
 
       def load!
-        puts data_file
         @data = YAML.load_file( data_file ).with_indifferent_access
         idify_data!
         puts "#{self} successfully loaded data"

data/lib/yaml_b_sides/index.rb

@@ -0,0 +1,16 @@
+module YamlBSides
+  class Index
+    def initialize(field, data)
+      @indexed_data = {}
+      data.each do |id, datum|
+        key = datum[field]
+
+        @indexed_data[key] = Array(@indexed_data[key]) + [id]
+      end
+    end
+
+    def find(value)
+      @indexed_data[value]
+    end
+  end
+end

data/lib/yaml_b_sides/indexable.rb

@@ -0,0 +1,35 @@
+module YamlBSides
+  module Indexable
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :__indices
+      self.__indices = {}
+
+      class << self
+        def index(field)
+          self.__indices = __indices.merge( { field => Index.new(field, @data) } )
+        end
+
+        def find_in_index(field, value)
+          keys = Array(index_for(field).find(value))
+          
+          keys.map do |id|
+            find(id)
+          end
+        end
+
+        def indexed?(field)
+          __indices[field].present?
+        end
+
+        protected 
+
+        def index_for(field)
+          __indices[field]
+        end
+
+      end
+    end
+  end
+end

data/lib/yaml_b_sides/instanceable.rb

@@ -4,10 +4,6 @@ module YamlBSides
     included do
       include ActiveModel::Model
 
-      def initialize( attrs = {} )
-        @attributes = self.class.__properties.merge( attrs ).with_indifferent_access
-      end
-
       def method_missing( method, *args, &block )
         if @attributes.has_key? method
           method = @attributes[method]
@@ -16,8 +12,11 @@ module YamlBSides
         end
       end
 
-      def to_param
-        id
+      protected
+
+      # public init really doesn't make sense for a read-only interface
+      def initialize( attrs = {} )
+        @attributes = self.class.__properties.merge( attrs ).with_indifferent_access
       end
     end
   end

data/lib/yaml_b_sides/queriable.rb

@@ -9,6 +9,26 @@ module YamlBSides
         end
 
         def find_by(params = {})
+          if all_indexed?(params.keys)
+            find_by_indexed(params)
+          else
+            find_by_scan(params)
+          end
+        end
+
+        def all
+          @data.values.map do |obj|
+            new obj
+          end
+        end
+
+        def first
+          new @data.values.first
+        end
+
+        private
+
+        def find_by_scan(params)
           result = @data.values.find do |datum|
             params.all? do |param, expcted_value|
               datum[param] == expcted_value
@@ -17,9 +37,25 @@ module YamlBSides
           result ? new(result) : nil
         end
 
-        def all
-          @data.values.map do |obj|
-            new obj
+        def find_by_indexed(params)
+          sets = []
+          params.each do |index, value|
+            sets << find_in_index(index, value)
+          end
+
+          # find the intersection of all the sets
+          sets.inject( sets.first ) do |result, subset|
+            result & subset
+         end
+        end
+
+        def all_indexed?(fields)
+          fields.all? do |field|
+            indexed = indexed? field
+            unless indexed
+              logger.warn "You are running a query on #{self}.#{field} which is not indexed. This will perform a table scan."
+            end
+            indexed
           end
         end
       end

data/lib/yaml_b_sides/version.rb

@@ -1,3 +1,3 @@
 module YamlBSides
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/yaml_b_sides.rb

@@ -11,6 +11,8 @@ module YamlBSides
   autoload :Base,           'yaml_b_sides/base'
   autoload :Cacheable,      'yaml_b_sides/cacheable'
   autoload :Instanceable,   'yaml_b_sides/instanceable'
+  autoload :Index,          'yaml_b_sides/index'
+  autoload :Indexable,      'yaml_b_sides/indexable'
   autoload :Propertiable,   'yaml_b_sides/propertiable'
   autoload :Queriable,      'yaml_b_sides/queriable'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaml_b_sides
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Greg Orlov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-01 00:00:00.000000000 Z
+date: 2016-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -99,6 +99,8 @@ files:
 - lib/yaml_b_sides.rb
 - lib/yaml_b_sides/base.rb
 - lib/yaml_b_sides/cacheable.rb
+- lib/yaml_b_sides/index.rb
+- lib/yaml_b_sides/indexable.rb
 - lib/yaml_b_sides/instanceable.rb
 - lib/yaml_b_sides/propertiable.rb
 - lib/yaml_b_sides/queriable.rb
@@ -129,3 +131,4 @@ signing_key:
 specification_version: 4
 summary: A light AcriveRecord like wrapper for flat YAML files
 test_files: []
+has_rdoc: