static_models 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14b52ac6a5f6d2ea3a9cd809e96dc9a5d3a9bd84
-  data.tar.gz: 0fe26ca5989a19dbdf39805a156e4dd4a16509dc
+  metadata.gz: 65dff81c399c94a47e52447d832acd3cff5922d7
+  data.tar.gz: a736899f5666ee1281d50e29a457c1b6faca1547
 SHA512:
-  metadata.gz: 8d2a70e05c48350c0a4c48b3924403a511358dab5f09c9fd9bd71a2cfe84835c938b09324ac06cdf4610c11878e4218cb49848bb29311220f3bd8148d982ec27
-  data.tar.gz: 0559dd452091ec6fd0954d10eb81d70a1450a2ce9e2efd4baf0f8b78890dacb90ad6e536ada21cadbcce89db90b6f1c4b5f7aded2ac559e71572158f8141607b
+  metadata.gz: 0af88921adb55e963701874d2990d9bac7779202a40417e44847d3c60170bfd0a168e943e38469a4546e7f29566e7954a01688635d12da843430bb0025363cc1
+  data.tar.gz: 2123b43bf3c3948948e2531a9434a6a789952aab7e39eb9270a04c9c569eb564d922c7f154b10adcff8dd13e0f23bd5d8c26e5fc7d745b836828036afab6267d

data/README.md

@@ -22,6 +22,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Defining your models
+
 ```ruby
     # We're modelling Dogs, each of them has a Breed.
     # We support a static set of Breeds.
@@ -30,17 +32,18 @@ Or install it yourself as:
       # Enhance Breed to be a StaticModel
       include StaticModels::Model 
 
-      # Actually define the breeds we support using a Hash
-      # Keys are the 'id' attribute of each model. Must be Integers.
-      # Values are the 'code' attribute. Must be Symbols, and unique.
-      # If you want your model to have extra attributes, make the value
-      # be an Array of 2 elements: [Symbol, Hash].
-      static_models(
-        1 => :collie,
-        2 => :foxhound,
-        6 => [:corgi, height: 'short'],
-        7 => [:doberman, height: 'tall']
-      )
+      # Our StaticModel instances can be defined as a table.
+      # The first two columns are special:
+      # 'id' must be a Fixnum, and will be used internally as primary key.
+      # 'code' must be a Symbol, and will be used as a friendlier ID.
+      # Class methods will be created to fetch a StaticModel instance by code.
+      static_models_dense [
+        [:id, :code,      :height ],
+        [1,   :collie,    nil     ],
+        [2,   :foxhound,  nil     ],
+        [6,   :corgi,     'short' ],
+        [7,   :doberman,  'tall'  ],
+      ]
     end
 
     # You can find your Breed.
@@ -63,7 +66,7 @@ Or install it yourself as:
       Breed.doberman
     ]
 
-    # The low level 'values' dictionary is public.
+    # A low level 'values' dictionary is public.
     Breed.values.should == {
       1 => Breed.collie,
       2 => Breed.foxhound,
@@ -71,6 +74,23 @@ Or install it yourself as:
       7 => Breed.doberman
     }
 
+    # An alternative syntax is supported to use with sparse attribute definitions
+    # Here's a definition of Breed with sparse attributes.
+    class SparseBreed
+      include StaticModels::Model
+      static_models_sparse [
+        [1, :collie],
+        [2, :foxhound],
+        [6, :corgi, height: 'short'],
+        [7, :doberman,  height: 'tall'],
+      ]
+    end
+```
+
+### PORO's and ActiveRecords can belongs_to a StaticModel
+
+```ruby
+
     # You point to your StaticModels like an ActiveRecords belongs_to association
     # Setting a Breed will update a breed_id attribute.
     class Dog

data/lib/static_models/version.rb

@@ -1,3 +1,3 @@
 module StaticModels
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/static_models.rb

@@ -7,45 +7,65 @@ module StaticModels
     extend ActiveSupport::Concern
 
     included do |i|
-      cattr_accessor :values
+      cattr_accessor :values, :id_column, :code_column
 
-      def initialize(id, code, *args)
-        self.id = id
-        self.code = code
-        unless args.empty?
-          args.first.each{|name,value| send("#{name}=", value) }
-        end
+      def initialize(attributes)
+        attributes.each{|name,value| send("#{name}=", value) }
       end
 
-      def to_s; code.to_s; end
-      def to_i; id; end
-      def name; code; end
+      def name; send(self.class.code_column); end
+      def to_s; name.to_s; end
+      def to_i; send(self.class.id_column); end
     end
 
     class_methods do
-      def static_models(new_values)
-        attr_accessor :id, :code
+      def static_models_dense(table)
+        columns = table.first
+        hashes = table[1..-1].collect do |row|
+          Hash[*columns.zip(row).flatten(1)]
+        end
 
-        self.values = {}
-        new_values.each do |k,v|
-          unless k.is_a?(Integer)
-            raise TypeError.new("Expected Integer for keys, found #{k.class}")
-          end
+        static_models_hashes columns, hashes
+      end
 
-          if v.is_a?(Array)
-            unless v.size == 2 && v.first.is_a?(Symbol) && v.last.is_a?(Hash)
-              raise TypeError.new("Expected [Symbol, Hash] found #{v.class}") 
-            end
-            attr_accessor *v.last.keys
-          else
-            unless v.is_a?(Symbol)
-              raise TypeError.new("Expected Symbol, found #{v.class}")
-            end
+      def static_models_sparse(table)
+        table.each do |row|
+          expected = row.size == 2 ? [Fixnum, Symbol] : [Fixnum, Symbol, Hash]
+
+          if row.collect(&:class) != expected
+            raise ValueError.new("Invalid row #{row}, expected #{expected}")
           end
-          item = new(k, *v)
-          values[k] = item
+        end
+
+        columns = table.select{|r| r.size == 3}
+          .collect{|r| r.last.keys }.flatten(1).uniq
 
-          raise DuplicateCodes.new if singleton_methods.include?(item.code)
+        hashes = table.collect{ |r| (r[2] || {}).merge(id: r[0], code: r[1]) }
+        static_models_hashes ([:id, :code] + columns), hashes
+      end
+
+      def static_models_hashes(columns, hashes)
+        unless columns.all?{|c| c.is_a?(Symbol)}
+          raise ValueError.new("Table column names must all be Symbols")
+        end
+
+        unless hashes.all?{|h| h[:id].is_a?(Fixnum)}
+          raise ValueError.new("Ids must be integers")
+        end
+
+        unless hashes.all?{|h| h[:code].is_a?(Symbol)}
+          raise ValueError.new("Codes must be Symbols")
+        end
+
+        attr_accessor *columns
+        self.id_column = columns[0]
+        self.code_column = columns[1]
+
+        self.values = {}
+        hashes.each do |hash|
+          item = new(hash)
+          values[item.id] = item
+          raise ValueError.new if singleton_methods.include?(item.code)
           define_singleton_method(item.code){ item }
         end
       end
@@ -89,7 +109,7 @@ module StaticModels
 
         define_method("#{association}=") do |value|
           if expected_class && !value.nil? && value.class != expected_class
-            raise TypeError.new("Expected #{expected_class} got #{value.class}")
+            raise ValueError.new("Expected #{expected_class} got #{value.class}")
           end
 
           if value.nil? || value.class.include?(Model)
@@ -110,6 +130,5 @@ module StaticModels
     end
   end
 
-  class TypeError < StandardError; end
-  class DuplicateCodes < StandardError; end
+  class ValueError < StandardError; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: static_models
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - nubis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2017-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport