greyscale_record 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '04649514246f75d5ecd1d02fba8b1b773744d771'
+  data.tar.gz: de857e40fabfa2d27622f7f6957eed6b9602b5f3
+SHA512:
+  metadata.gz: eb2a45fc827f0e4e1f5ea48bfd0589c1d3e9c73cf605330bc8c50e18188723759425a72d6c88bedf8b9adc9b40c33f086d36fe1b58a923f47e26f87824e95b8f
+  data.tar.gz: d218efe8bda685f876c4526bc58bdafaaa8b56624901225abe9a3e74c0bccd75a9970579503869837dffc78e335413da269ab0081d0c89b8136868b7c9ced85d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gaorlov@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Greg Orlov
+
+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,225 @@
+# Greyscale Record
+
+`GreyscaleRecord` 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 a flat file format (e.g. yaml files). It is a clone of [YamlBSides](https://github.com/gaorlov/yaml_b_sides), but is extended to support multiple backend drivers (YAML files, Greyscale API)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'greyscale_record'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install greyscale_record
+
+## Usage
+
+`Greyscale Record` acts very mich like active record. You set up your base class like you would an ActiveRecord class:
+
+```ruby
+class Person < GreyscaleRecord::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: `Greyscale Record` 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
+
+### 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
+
+#### Assocaition Options
+
+Associations have some of the standard ActiveRecord options. Namely:
+* `class`: specifies the class to find the record in.
+  
+  ```ruby
+    has_one :special_thing, class: Thing
+  ```
+
+* `class_name`: specifies the class w.o having to have the class defined. Handy for circular dependencies
+  
+  ```ruby
+    class Person < GreyscaleRecord::Base
+      has_one :nickname, class_name: "Pesudonym"
+    end
+
+    class Pseudonym < GreyscaleRecord::Base
+      belongs_to :bearer, class_name: "Person"
+    end
+  ```
+
+* `through`: many to may association helper. 
+  
+  ```ruby
+    class Person < GreyscaleRecord::Base
+      has_many :person_foods
+      has_many :favorite_foods, through: :person_foods, class_name: "Food"
+    end
+
+    class PersonFood < GreyscaleRecord::Base
+      belongs_to :person
+      belongs_to :food
+    end
+
+    class Food < GreyscaleRecord::Base
+    end
+  ```
+  
+  __NOTE__: only works for `has_one` and `has_many`
+
+* `as`: specifies what the associated object calls the caller
+  ```ruby
+    class Person
+      has_many :images, as: :target
+    end
+
+    class Image
+      belongs_to :target, class: Person
+    end
+  ```
+  __NOTE__: only works for `has_one` and `has_many`
+
+* `polymorphic`: specifies a polymorphic `belongs_to` association. Better explanation [here, on the ActiveRecord page](http://guides.rubyonrails.org/association_basics.html#polymorphic-associations)
+  ```ruby
+    class Person
+      has_many :images, as: :target
+    end
+
+    class Party
+      has_many :images, as: :target
+    end
+
+    class Image
+      belongs_to :target, polymorphic: true
+    end
+  ```
+  And then the `images.yml` looks something like
+  ```yml
+    image-1:
+      thing_id: a
+      thing_class: Person
+      # ...
+    image-2:
+      thing_id: a
+      thing_class: PArty
+      #...
+  ```
+
+### Example
+
+To use the `People` class from earlier, a fully fleshed out model would look something like:
+
+```ruby
+class Person < GreyscaleRecord::Base
+  property   :name, ""
+  properties url_slug: "",
+             bio: ""
+
+  has_many :nicknames
+
+  index :name
+  index :url_slug
+end
+
+class Nickname < GreyscaleRecord::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. Greyscale Record wants a logger and a base dir to look for files in. An example config for a Rails app would look like:
+
+```ruby
+GreyscaleRecord::logger = Rails.logger
+# for now this is the only driver
+GreyscaleRecord::Base.driver = GreyscaleRecord::Drivers::Yaml
+GreyscaleRecord::Drivers::Yaml.root = Rails.root.join 'db', 'fixtures'
+
+
+# in development.rb
+
+# eanble reload of the data files to avoid having to restart the server for every change
+GreyscaleRecord.live_reload = true
+```
+
+## 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/gaorlov/greyscale_record.
+
+
+## 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 "greyscale_record"
+
+# 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/greyscale_record.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'greyscale_record/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "greyscale_record"
+  spec.version       = GreyscaleRecord::VERSION
+  spec.authors       = ["Greg Orlov"]
+  spec.email         = ["gaorlov@gmail.com"]
+
+  spec.summary       = "A light AcriveRecord like wrapper for a flat data interface, such as YAML files, or the Geyscale API"
+  spec.description   = "An ActiveRecord-like interface for reading from & queryeing flat data interfaces"
+  spec.homepage      = "https://github.com/greyscale-io/greyscale_record"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "activemodel"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "m"
+
+end

data/lib/greyscale_record/associatable.rb

@@ -0,0 +1,57 @@
+module GreyscaleRecord
+  module Associatable
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :__associations
+      self.__associations = {}
+
+      attr_accessor :_cached_associations
+
+      class << self
+
+        def belongs_to( name, opts = {} )
+          association = Associations::BelongsTo.new( self, name, opts )
+          process association
+          index association.key
+        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
+            begin
+              self._cached_associations ||= {}
+
+              unless self._cached_associations.has_key? association.name
+                result = association.klass( self ).send( association.action, association.query( self ) )
+                
+                self._cached_associations[association.name] = result
+              end
+              self._cached_associations[association.name]
+            rescue GreyscaleRecord::Errors::RecordNotFound => e
+              nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/greyscale_record/associations/base.rb

@@ -0,0 +1,53 @@
+module GreyscaleRecord
+  module Associations
+    class Base
+
+      attr_accessor :name, :opts, :key
+
+      def initialize( base_class, name, opts = {} )
+        self.name = name
+        self.opts = opts
+        self.key  = idify base_class
+
+        sanitize_opts( base_class )
+      end
+
+      def klass( instance = nil )
+        @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
+
+        a_class || a_class_name || derived_class_for( name )
+      end
+
+      def derived_class_for( name )
+        name.to_s.singularize.classify.constantize
+      end
+
+      def idify( class_name )
+        "#{class_name.to_s.demodulize.underscore}_id"
+      end
+
+      def supported_options
+        [ :class, :class_name ] + additional_options
+      end
+
+      def sanitize_opts( base_class )
+        if name.to_s == "object"
+          raise GreyscaleRecord::Errors::AssociationError, "#{base_class}: 'object_id' is a reserved keyword in ruby and cannot be overridden"
+        end
+        invalid_options = (opts.keys - supported_options)
+        if invalid_options.present?
+          list = invalid_options.map{|o|"'#{o}'"}.to_sentence
+          plural = invalid_options.count > 1
+          raise GreyscaleRecord::Errors::AssociationError, "#{base_class}: #{list} #{plural ? "are" : "is"} not supported. Please see README for full details: http://www.github.com/greyscale-io/greyscale_record"
+        end
+      end
+    end
+  end
+end

data/lib/greyscale_record/associations/belongs_to.rb

@@ -0,0 +1,36 @@
+module GreyscaleRecord
+  module Associations
+    class BelongsTo < Base
+      def action
+        :find
+      end
+
+      def key
+        "#{name}_id"
+      end
+
+      def query( instance )
+        instance.send key
+      end
+
+      def klass( instance )
+        if polymorphic?
+          class_name = instance.send "#{name}_class"
+          class_name.constantize
+        else
+          super
+        end
+      end
+
+      protected
+
+      def additional_options
+        [ :polymorphic ]
+      end
+
+      def polymorphic?
+        opts[:polymorphic]
+      end
+    end
+  end
+end

data/lib/greyscale_record/associations/has_many.rb

@@ -0,0 +1,11 @@
+module GreyscaleRecord
+  module Associations
+    class HasMany < Base
+      include Hasable
+
+      def action
+        :where
+      end
+    end
+  end
+end

data/lib/greyscale_record/associations/has_one.rb

@@ -0,0 +1,11 @@
+module GreyscaleRecord
+  module Associations
+    class HasOne < Base
+      include Hasable 
+
+      def action
+        :find_by
+      end
+    end
+  end
+end

data/lib/greyscale_record/associations/hasable.rb

@@ -0,0 +1,54 @@
+module GreyscaleRecord
+  module Associations
+    module Hasable
+      extend ActiveSupport::Concern
+
+      included do
+
+        def query( instance )
+          if through?
+            { id: target_ids( instance ) }
+          elsif as?
+            { "#{as}_id" => instance.id }
+          else
+            { key => instance.id }
+          end
+        end
+
+        def additional_options
+          [ :as, :through ]
+        end
+
+        protected
+
+        def through
+          opts[:through]
+        end
+
+        def through?
+          opts.has_key? :through
+        end
+
+        def as
+          opts[:as]
+        end
+
+        def as?
+          opts.has_key? :as
+        end
+
+        def target_ids( instance )
+          intermadiates = Array(instance.send( through ) )
+          
+          intermadiates.map do | intermediate | 
+            intermediate.send( through_key )
+          end
+        end
+        
+        def through_key
+          idify klass
+        end
+      end
+    end
+  end
+end

data/lib/greyscale_record/associations.rb

@@ -0,0 +1,9 @@
+module GreyscaleRecord
+  module Associations
+    autoload :Base,       'greyscale_record/associations/base'
+    autoload :BelongsTo,  'greyscale_record/associations/belongs_to'
+    autoload :Hasable,    'greyscale_record/associations/hasable'
+    autoload :HasMany,    'greyscale_record/associations/has_many'
+    autoload :HasOne,     'greyscale_record/associations/has_one'
+  end
+end

data/lib/greyscale_record/base.rb

@@ -0,0 +1,48 @@
+module GreyscaleRecord
+  class Base
+    include ActiveModel::Model
+    include Associatable
+    include Cacheable
+    include Propertiable
+    include Indexable
+    include Instanceable
+    include Queriable
+
+    class_attribute :data
+    class_attribute :driver
+
+    class << self
+
+      def load!
+        @data = driver.load!(_class_name)
+        return unless @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
+        idify_data!
+        
+        index :id unless GreyscaleRecord.live_reload
+      end
+
+      def inherited(subclass)
+        subclass.load!
+      end
+
+      protected
+
+      def _class_name
+        self.name.pluralize.downcase
+      end
+
+      def idify_data!
+        @data.each do |k, v|
+          v[:id] = k
+        end
+      end
+
+      def data
+        load! if GreyscaleRecord.live_reload
+        @data
+      end
+    end
+  end
+end

data/lib/greyscale_record/cacheable.rb

@@ -0,0 +1,17 @@
+module GreyscaleRecord
+  module Cacheable
+    extend ActiveSupport::Concern
+
+    included do
+      class << self
+        def cache_key
+          @cache_key ||= Digest::SHA256.hexdigest(data.to_json)
+        end
+      end
+
+      def cache_key
+        @cache_key ||= Digest::SHA256.hexdigest(@attributes.to_json)
+      end
+    end
+  end
+end

data/lib/greyscale_record/drivers/base.rb

@@ -0,0 +1,31 @@
+module GreyscaleRecord
+  module Drivers
+    class Base
+
+      class_attribute :root
+      
+      class << self
+        def load!(class_name)
+
+          raise GreyscaleRecord::DriverError "driver needs to define a `root`" unless root
+          
+          data = load_data(class_name)
+          
+          GreyscaleRecord.logger.info "#{class_name} successfully loaded data"
+
+          data
+
+        rescue => e
+          GreyscaleRecord.logger.error "#{self} failed to load data for #{class_name}: #{e}"
+          return nil
+        end
+
+        private 
+
+        def load_data
+          raise NotImplementedError "load_data is not implemented"
+        end
+      end
+    end
+  end
+end

data/lib/greyscale_record/drivers/yaml.rb

@@ -0,0 +1,19 @@
+module GreyscaleRecord
+  module Drivers
+    class Yaml < Base
+
+      class << self
+
+        private 
+
+        def load_data( class_name )
+          YAML.load_file( data_file( class_name ) ).with_indifferent_access
+        end
+
+        def data_file( class_name )
+          [root, "#{class_name}.yml"].compact.join("/")
+        end
+      end
+    end
+  end
+end

data/lib/greyscale_record/drivers.rb

@@ -0,0 +1,7 @@
+module GreyscaleRecord
+  module Drivers
+    autoload :Base,           'greyscale_record/drivers/base'
+    autoload :GreyscaleAPI,   'greyscale_record/drivers/greyscale_api'
+    autoload :Yaml,           'greyscale_record/drivers/yaml'
+  end
+end

data/lib/greyscale_record/errors.rb

@@ -0,0 +1,15 @@
+module GreyscaleRecord
+  module Errors
+    class RecordNotFound < StandardError
+    end
+
+    class AssociationError < StandardError
+    end
+
+    class InvalidFieldError < StandardError
+    end
+
+    class DriverError < StandardError
+    end
+  end
+end

data/lib/greyscale_record/index.rb

@@ -0,0 +1,23 @@
+module GreyscaleRecord
+  class Index
+    def initialize(field, data)
+      @indexed_data = {}
+      data.each do |id, datum|
+        key = datum[field]
+
+        # storing key => array of matching ids
+        @indexed_data[key] = Array(@indexed_data[key]) + [id]
+      end
+    end
+
+    # returns ids 
+    def find(values)
+      # find all the arrays of ids for the values, 
+      #   get rid of nils (value not present), 
+      #   and compact for a single array result
+      values.map do |value|
+        @indexed_data[value]
+      end.compact.flatten
+    end
+  end
+end

data/lib/greyscale_record/indexable.rb

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

data/lib/greyscale_record/instanceable.rb

@@ -0,0 +1,23 @@
+module GreyscaleRecord
+  module Instanceable
+    extend ActiveSupport::Concern
+    included do
+      include ActiveModel::Model
+
+      def method_missing( method, *args, &block )
+        if @attributes.has_key? method
+          method = @attributes[method]
+        else
+          raise GreyscaleRecord::Errors::InvalidFieldError, "#{self.class}:#{@attributes[:id]}: Invalid field: '#{method}'"
+        end
+      end
+
+      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
+end

data/lib/greyscale_record/propertiable.rb

@@ -0,0 +1,27 @@
+module GreyscaleRecord
+  module Propertiable
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :__properties
+      self.__properties = {}
+
+      class << self
+        def properties( props = {} )
+          self.__properties = __properties.dup
+          merge_properties props
+        end
+
+        def property( prop, default = nil )
+          merge_properties( { prop => default } )
+        end
+
+        protected
+
+        def merge_properties( additional_properties = {} )
+          self.__properties = __properties.merge( additional_properties )
+        end
+      end
+    end
+  end
+end

data/lib/greyscale_record/queriable.rb

@@ -0,0 +1,75 @@
+module GreyscaleRecord
+  module Queriable
+    extend ActiveSupport::Concern
+
+    included do
+      class << self
+        def find(id)
+          record = data[id]
+          raise Errors::RecordNotFound, "#{self}: Record not found: #{id}" unless record
+          new record
+        end
+
+        def find_by(params = {})
+          results = where params
+          raise Errors::RecordNotFound, "#{self}: Could not find record that matches: #{params.inspect}" if results.empty?
+          results.first
+        end
+
+        def all
+          data.values.map do |obj|
+            new obj
+          end
+        end
+
+        def first
+          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.values.select do |datum|
+            params.all? do |param, expected_value|
+              val = Array(expected_value).include? datum[param]
+            end
+          end
+        end
+
+        def find_by_indexed(params)
+          sets = []
+          params.each do |index, values|
+            sets << find_in_index(index, Array(values))
+          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
+              GreyscaleRecord.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
+    end
+  end
+end

data/lib/greyscale_record/version.rb

@@ -0,0 +1,3 @@
+module GreyscaleRecord
+  VERSION = "0.0.1"
+end

data/lib/greyscale_record.rb

@@ -0,0 +1,30 @@
+require "greyscale_record/version"
+require 'active_model'
+require 'active_model/model'
+require 'active_support'
+require 'active_support/concern'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/hash'
+require 'yaml'
+
+module GreyscaleRecord
+  autoload :Associatable,   'greyscale_record/associatable'
+  autoload :Associations,   'greyscale_record/associations'
+  autoload :Base,           'greyscale_record/base'
+  autoload :Cacheable,      'greyscale_record/cacheable'
+  autoload :Drivers,        'greyscale_record/drivers'
+  autoload :Errors,         'greyscale_record/errors'
+  autoload :Instanceable,   'greyscale_record/instanceable'
+  autoload :Index,          'greyscale_record/index'
+  autoload :Indexable,      'greyscale_record/indexable'
+  autoload :Propertiable,   'greyscale_record/propertiable'
+  autoload :Queriable,      'greyscale_record/queriable'
+
+  class << self
+    attr_accessor :live_reload
+    attr_accessor :logger
+  end
+
+  self.live_reload  = false
+  self.logger       = Logger.new(STDOUT)
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: greyscale_record
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Greg Orlov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-29 00:00:00.000000000 Z
+dependencies:
+- !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: activemodel
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: m
+  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'
+description: An ActiveRecord-like interface for reading from & queryeing flat data
+  interfaces
+email:
+- gaorlov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- greyscale_record.gemspec
+- lib/greyscale_record.rb
+- lib/greyscale_record/associatable.rb
+- lib/greyscale_record/associations.rb
+- lib/greyscale_record/associations/base.rb
+- lib/greyscale_record/associations/belongs_to.rb
+- lib/greyscale_record/associations/has_many.rb
+- lib/greyscale_record/associations/has_one.rb
+- lib/greyscale_record/associations/hasable.rb
+- lib/greyscale_record/base.rb
+- lib/greyscale_record/cacheable.rb
+- lib/greyscale_record/drivers.rb
+- lib/greyscale_record/drivers/base.rb
+- lib/greyscale_record/drivers/yaml.rb
+- lib/greyscale_record/errors.rb
+- lib/greyscale_record/index.rb
+- lib/greyscale_record/indexable.rb
+- lib/greyscale_record/instanceable.rb
+- lib/greyscale_record/propertiable.rb
+- lib/greyscale_record/queriable.rb
+- lib/greyscale_record/version.rb
+homepage: https://github.com/greyscale-io/greyscale_record
+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.2
+signing_key: 
+specification_version: 4
+summary: A light AcriveRecord like wrapper for a flat data interface, such as YAML
+  files, or the Geyscale API
+test_files: []