fixed_model 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c9db27f13b391e27b06f3deee776d0cc8b35a5e
+  data.tar.gz: 4e090077c600752a89fd77b46615e8a5b72b7d54
+SHA512:
+  metadata.gz: a86581d29697003d548e319606dadc70a17c42f3fff044209e2c6739a4dceb9301d013d22d42435cfdae83b1e4e877fd43338d03095481b8a84d8a27a2d0290f
+  data.tar.gz: e4079963dfbf17016c01b69c6b49ca99d44ef02e8b7e8f27abf4b4902e30f6500e5e0cf170e3c7651a6113caeb71983bf183d3f23ecf6f79f98d3cc4dcaaf528

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 mollerhoj
+
+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,113 @@
+Fixed Model
+==========
+
+Fixed Models act like ActiveRecord models, but they are immutable and read from data files.
+
+Sometimes we need static data in our applications. It can often be modeled as models in the MVC pattern. Instead of storing such data in the database, it can be useful to store the data in simple datafiles.
+
+This has several advantages:
+
+- It makes it easier for developers to quickly inspect and edit the data.
+- It is trivial to make sure the data is never modified.
+- It makes it easier to make assumptions about what records exists.
+
+Installing
+-----------
+Include `gem fixed_model` in your `Gemfile` and run `bundle install`
+
+Usage
+-----------
+
+To use a FixedModel, inherit from `FixedModel::Base`:
+
+```ruby
+class Country < FixedModel::Base
+  
+end
+```
+
+The model will read from `config/fixed_models/countries.yml`, an example of such a file could be:
+
+```yaml
+---
+denmark:
+  name: Denmark
+  capital: Copenhagen
+
+england:
+  name: England
+  language: English
+  capital: London
+  center:
+    - 53.562925
+    - 1.806361
+  features:
+    - :drive_on_left_side
+  cities:
+    :london:
+      :name: London
+      :status: :capital
+```
+
+The outermost keys (in this case `denmark` and `england` will be discarded. They are only used as primary keys for merging multiple data files. (See the section "Merge files from multiple file paths").
+
+Merge files from multiple file paths
+------------------------------------
+
+The file paths can be changed by setting `FixedModel.file_paths`. The default is:
+
+```
+FixedModel.file_paths = ['config/fixed_models']
+```
+
+The data in latter file paths will override values in the former. This makes it possible to set values specific to different environments. For example, the `countries.yml` file from the previous section might have different names in production. The file `config/fixed_models/production/countries.yml` can specify that:
+
+```yaml
+---
+england:
+  name: ENGLAND
+```
+
+In the case of arrays and hashes, the former files will be appended to the latter. So in the example below England would end up with both the `:rail_roads` and the `:drive_on_left_side` features. As well as the cities `:london` and `:manchester`:
+
+```yaml
+---
+england:
+  name: England
+  features:
+   - :rail_roads
+  cities:
+    :manchester:
+      :name: Manchester
+```
+
+The default file paths depend on the environment. In the development environment, the data will be read from `config/fixed_models` and `config/fixed_models/development`. To change this behavior, set:
+
+```ruby
+FixedModel.use_environment_file_paths = false
+```
+
+Supported methods
+-----------------
+
+Fixed Models support the most common methods used on ActiveRecord models:
+
+Class methods:
+```
+find, first, second, third, fourth, last, all, count, each, attribute_names
+```
+
+Dynamic class methods. (here, attribute name is `capital`)
+```
+find_by_capital, find_by_capital! 
+```
+
+Instance methods:
+```
+persisted?, new_record?, read_attribute
+```
+
+Dynamic instance methods:
+```
+capital, capital?, attribute_names
+```

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FixedModel'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/fixed_model.rb

@@ -0,0 +1,12 @@
+module FixedModel
+  autoload :Base, "fixed_model/base"
+  autoload :Loader, "fixed_model/loader"
+
+  cattr_accessor :file_paths
+  cattr_accessor :use_environment_paths
+
+  @@file_paths = ['config/fixed_models']
+  @@use_environment_paths = true
+
+  class RecordNotFound < StandardError; end
+end

data/lib/fixed_model/base.rb

@@ -0,0 +1,125 @@
+module FixedModel
+  class Base
+    include ActiveModel::Model
+    include ActiveModel::AttributeMethods
+
+    attribute_method_suffix '?'
+
+    class << self
+      delegate :find, :first, :first!, :last, :second, :second!, :third, 
+        :third!, :fourth, :fourth!, :fifth, :fifth!, :forty_two, :forty_two!,
+        :count, to: :all
+    end
+
+    def initialize(row={})
+      @row = row
+      define_attribute_readers
+    end
+
+    def persisted?
+      true
+    end
+
+    def new_record?
+      false
+    end
+
+    def attributes
+      @row.dup.freeze
+    end
+
+    def self.inherited(subclass)
+      subclass.define_find_by_attributes
+      subclass.define_find_by_attributes!
+      define_attribute_methods(subclass.attribute_names)
+    end
+
+    def attribute?(attr)
+      send(attr.to_sym).present?
+    end
+
+    def self.attribute_names
+      names = []
+      data.each do |row|
+        names.concat(row.keys)
+      end
+      names.uniq.map(&:to_s)
+    end
+
+    def self.all
+      data.map { |row| new(row) }
+    end
+
+    def self.each(&block)
+      all.each(&block)
+    end
+
+    def attribute_names
+      @row.keys.map(&:to_s)
+    end
+
+    def read_attribute(attribute)
+      @row[attribute]
+    end
+
+    def ==(other)
+      other.instance_of?(self.class) && other.attributes == attributes
+    end
+
+    private
+
+    # Seems to be called when denmark.language is not defined and called.
+    # Look in rails source for explanation...
+    def attribute(attribute)
+      nil
+    end
+
+    def define_attribute_readers
+      attribute_names.each do |attribute_name|
+        define_singleton_method attribute_name do
+          read_attribute(attribute_name)
+        end
+      end
+    end
+
+    def self.singleton_class
+      class << self
+        self
+      end
+    end
+
+    def self.define_find_by_attribute(attribute)
+      singleton_class.send :define_method, "find_by_#{attribute}" do |arg|
+        row = data.find { |i| i[attribute] == arg } # or sym?
+        row ? self.new(row) : nil
+      end
+    end
+
+    def self.define_find_by_attribute!(attribute)
+      singleton_class.send :define_method, "find_by_#{attribute}!" do |arg|
+        row = data.find { |i| i[attribute] == arg } # or sym?
+        if row
+          self.new(row)
+        else
+          raise FixedModel::RecordNotFound
+        end
+      end
+    end
+
+    def self.define_find_by_attributes
+      attribute_names.each do |attribute|
+        define_find_by_attribute(attribute)
+      end
+    end
+
+    def self.define_find_by_attributes!
+      attribute_names.each do |attribute|
+        define_find_by_attribute!(attribute)
+      end
+    end
+
+    def self.data
+      @data ||= FixedModel::Loader.new(self).load
+    end
+  end
+end

data/lib/fixed_model/loader.rb

@@ -0,0 +1,41 @@
+module FixedModel
+  class Loader
+    def initialize(model_name)
+      @model_name = model_name
+    end
+
+    def load
+      data = {}
+      files.each do |file|
+        merge_data(data, YAML.load(File.read(file)))
+      end
+      data.values
+    end
+
+    def merge_data(row, new_row)
+      new_row.each do |key, value|
+        if row[key].is_a?(Hash) && value.is_a?(Hash)
+          merge_data(row[key], value)
+        elsif row[key].is_a?(Array) && value.is_a?(Array)
+          row[key].concat(value)
+        else
+          row[key] = value
+        end
+      end
+    end
+
+    def files
+      plural_model_name = ActiveModel::Naming.plural(@model_name)
+      files = []
+      FixedModel.file_paths.each do |file_path|
+        files << File.join(Rails.root, file_path, "#{plural_model_name}.yml")
+        if FixedModel.use_environment_paths
+          file = File.join(Rails.root, file_path, 'test',"#{plural_model_name}.yml")
+          files << file if File.exists?(file)
+        end
+      end
+      files
+    end
+  end
+end
+

data/lib/fixed_model/version.rb

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

data/lib/tasks/fixed_model_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :fixed_model do
+#   # Task goes here
+# end

data/test/compliance_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+# class ComplianceTest < ActiveSupport::TestCase
+#   include ActiveModel::Lint::Tests
+# 
+#   def setup
+#     @model = Country.new
+#   end
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */