permanent_record 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: adcecb24f1c6611a113103ac06b26e589f321563
+  data.tar.gz: 69fe494a2595ab8f74044fcdda83ddd13f162d73
+SHA512:
+  metadata.gz: 5498cb313de9b9064ccba63c81490d2910f7b406186a8812a040ada0a34491994726f11cdfa9f010390ba758f60dc17ef2ac7a82082dc489b38c5a48be5d2ec2
+  data.tar.gz: 0f94c0aa82601ed43fc81b2c0fb999fe8e364091e95bd2d73cff47bb65a66caad20cdb9279accbc898c59bf25b4e830b12c9cff003ca6ae0d8c7a5444982154b

data/lib/permanent_record.rb

@@ -0,0 +1,188 @@
+require 'active_model'
+require 'active_support/core_ext/hash'
+
+class PermanentRecord
+
+  # Get goodies for model_name, etc from ActiveModel.
+  # This allows normal Rails path helper generation.
+  #
+  extend ActiveModel::Naming
+
+  # Constructs a new PermanentRecord instance.
+  # Set instance variable and reader based on input hash.
+  #
+  def initialize attrs={}
+    attrs.each do |key, value|
+      if valid_attribute? key
+        self.instance_variable_set("@#{key}", value) 
+        self.class.class_eval{attr_reader key}
+      end
+    end
+  end
+
+  # For working with Rails routing helpers.
+  # Override in your PermanentRecord class to adjust URLs.
+  #
+  def to_param
+    self.id
+  end
+
+  # Overrides equality to match ids.
+  #
+  def == model
+    self.id == model.id
+  end
+
+  class << self
+    # Returns collection of all PermanentRecord instances.
+    #
+    # Example:
+    #   >> Model.all
+    #   => [@model1, @model2, ...]
+    #
+    def all
+      data.map{|d| self.new(d)}
+    end
+
+    # Find instance given id.
+    # Returns instance if found; nil otherwise.
+    #
+    # Example:
+    #   >> Model.find(42)
+    #   => @model
+    #
+    def find id
+      self.find_by_attribute(:id, id)
+    end
+
+    # Find instance given attribute name and expected value.
+    # Returns instance if found; nil otherwise.
+    #
+    # Example:
+    #   >> Model.find_by_attribute(:bacon, 'chunky')
+    #   => @model
+    #
+    def find_by_attribute key, value
+      found = data.find{|d| d[key.to_sym].to_s == value.to_s}
+      self.new(found) if found
+    end
+
+    # Find instance(s) given hash of attribute key/values.
+    # Returns all instances if found; empty array otherwise.
+    #
+    # Example:
+    #   >> Model.where(bacon: 'chunky', cats: 'calico')
+    #   => [@model1, @model2, ...]
+    #
+    def where *attrs
+      keys = attrs.first.keys
+      found = data.map{|d| d if d.reject{|key,_| !keys.include?(key)} == attrs.first}
+      found.compact.map{|f| self.new(f)}
+    end
+
+    # Oh, just for fun let's metaprogram some method missing!
+    # Provides 'find_by_<attr>' finders if you don't like 'where'.
+    # Returns instance if found; nil otherwise.
+    #
+    # Example:
+    #   >> Model.find_by_bacon('chunky')
+    #   => @model
+    #
+    def method_missing(method, *arguments, &block)
+      match = method.to_s.match(/^find_by_(.*)$/)
+      if match && valid_attribute?($1.to_sym)
+        find_by_attribute($1.to_sym, arguments.first)
+      else
+        super
+      end
+    end
+  end
+
+protected
+
+  # Check if attribute name is valid.
+  #
+  def valid_attribute? key
+    self.class.valid_attribute?(key)
+  end
+
+  class << self
+    # Declares source for PermanentRecord class data.
+    # PermanentRecord pretty much just wants to source any ol' array of hashes.
+    # If not declared, it'll default to a pluralized model name constant.
+    # ie: If your model is called MyModel, this'll try and find MY_MODELS.
+    #
+    # The default example, with NO source defined:
+    #   class MyModel < PermanentRecord
+    #   end
+    #
+    # Example with source constant explicitly defined:
+    #   class MyModel < PermanentRecord
+    #     source SOME_CONSTANT
+    #   end
+    #
+    # Another example with a source YAML file explicitly defined:
+    #  class MyModel < PermanentRecord
+    #    source YAML.load(File.read('path/to/yaml/file.yml'))
+    #  end
+    #
+    # I doubt you'd want to define your source as an explicit array of hash, 
+    # but just to drive home this "any array of hashes" idea here's an example:
+    #  class MyModel < PermanentRecord
+    #    source [{eyes: 'blue', hair: 'blonde'}, {eyes: 'brown', hair: 'green'}]
+    #  end
+    #
+    def source data=nil
+      @_data = format_data data
+    end
+
+    # Retrieve or load raw data.
+    #
+    def data
+      @_data ||= data_from_constant
+    end
+
+    # Auto load data from constant; pluralized model name
+    # ie: If your model is called ZooKeeper, this will try and
+    #     auto load a constant called ZOO_KEEPERS. You can put that
+    #     constant anywhere you want ... like in the model, or in
+    #     a constants.rb file, or maybe a zoo_keeprs.rb file.
+    #
+    def data_from_constant
+      data = eval(self.name.to_s.underscore.pluralize.upcase)
+      format_data data
+    end
+
+    # Add sequential id to all records.
+    # This can be overwritten if an id is specified in the data.
+    # CAUTION! If defining your own ids please make sure they're unique!
+    #
+    def format_data data
+      data = data.each_with_index.map{|d, i| {id: i+1}.merge(d)}
+      data.each(&:symbolize_keys!)
+    end
+
+    # Retrieve or load model attributes.
+    #
+    def attributes
+      @_attributes ||= attributes_from_data
+    end
+
+    # Find attributes based on first data item keys
+    # This might be something worth explicitly stating in an
+    # 'attributes' config or something... but for now I'm going
+    # with the lazy way out, and we'll just check the first data item.
+    # So please be sure to have well formed data!
+    #
+    def attributes_from_data
+      data.first.keys
+    end
+
+    # Check if attribute name is valid.
+    #
+    def valid_attribute? key
+      attributes.include?(key)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: permanent_record
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Caleb K Matthiesen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+description: ActiveRecord type READ ONLY data storage for small amounts of simple,
+  unchanging data.
+email:
+- c@calebkm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/permanent_record.rb
+homepage: https://github.com/calebkm/permanent_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.2.2
+signing_key: 
+specification_version: 4
+summary: Persistent Data without a DB.
+test_files: []
+has_rdoc: