trax_model 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7872fe10e5e8fcbe93b6897dd20c4b7da7890d1c
-  data.tar.gz: a3844a50a55a3a4d73699e5bddd8551539433e65
+  metadata.gz: ea648e5e27dcfea15c70cc7a42b75089f6a3511f
+  data.tar.gz: 611952b4b1f4031bf17d5e1857addabd371bb823
 SHA512:
-  metadata.gz: 9c4010865a9e93b936268e272cc554e1f45fd6082688c165855d5472f7f08bd4ac114cd9aa589e0ac1c08de4936c86b8bc6f187cea7f2412e9683c4c046ec2e1
-  data.tar.gz: 6f33aa0545ab904bee6517f1b58216bbe9b37ef18afa0a46d8ea871d4ea11e6d99d93fbf53fe671ce5332492b2583eb61272fe75473efdbc41415afb25d1e5d4
+  metadata.gz: 267094cef9ff8161ebc7029f41d59998495578fc17658aa41c5abb343be1fe31cae7e85d75e2ed4f37d196d80919f17d237b0500a2d88933d127759ebb7f479a
+  data.tar.gz: 456a2dbc24cddfabe0975be863ba62e4d4008630d0e1d551faa4378f2a5efc7abb095e98ba60df6410cf3f2a45883a387bcdf9b74e582e9046ec6cf0728becc9

data/lib/trax/model.rb

@@ -15,6 +15,7 @@ module Trax
     extend ::ActiveSupport::Autoload
 
     autoload :Config
+    autoload :Enum
     autoload :Errors
     autoload :Freezable
     autoload :Registry

data/lib/trax/model/enum.rb

@@ -0,0 +1,52 @@
+# An opinionated enum preconfiguration:
+# Uses simple_enum instead of active record built in enum, due to the complete
+# and utter polution it causes to your classes. in addition, AR does not prefix
+# enums with anything, i.e.
+# class User
+# enum :gender => [:unknown, :male, :female]
+# enum :locale => [:unknown, :en, :ca]
+# will break because :unknown cant be used twice, since it defines an User.unknown
+# method, the value which does not even make sense in alot of situations, out of context
+#
+# So, we use simple_enum instead, which will allow us to do that
+# in addition, I dont like that simple_enum does not allow you to raise errrors at the activerecord
+# level using validations, therefore you cant reuse the same interface for displaying errors
+# to the user if an invalid value is picked
+# so validation is added when an enum is defined
+# also defines just 2 generic scopes, by_enum_name, and by_enum_name_not, which accept multiple args
+# i.e. by_gender(:male), by_gender_not(:female, :unknown)
+# in interest of not polluting the class with scopes for each individual enum value
+
+module Trax
+  module Model
+    module Enum
+      extend ::ActiveSupport::Concern
+
+      module ClassMethods
+        def as_enum(enum_name, args, options = {})
+          options.assert_valid_keys(:prefix, :source, :message)
+          options[:message] ||= "Is not a valid value for #{enum_name}"
+          options[:prefix] ||= true
+          options[:source] ||= enum_name
+          enum_values = args.is_a?(Hash) ? args.keys : args
+          validation_options = { :in => enum_values, :message => options.extract!(:message) }
+
+          self.validates_inclusion_of(enum_name, validation_options)
+          scope_method_name = :"by_#{enum_name}"
+          scope_not_method_name = :"by_#{enum_name}_not"
+
+          self.scope scope_method_name, lambda { |*values|
+            enum_hash = self.__send__("#{enum_name}".pluralize).hash
+            where(enum_name => enum_hash.with_indifferent_access.slice(*values.flatten.compact.uniq).values)
+          }
+          self.scope scope_not_method_name, lambda { |*values|
+            enum_hash = self.__send__("#{enum_name}".pluralize).hash
+            where.not(enum_name => enum_hash.with_indifferent_access.slice(*values.flatten.compact.uniq).values)
+          }
+
+          super(enum_name, args, options)
+        end
+      end
+    end
+  end
+end

data/lib/trax_model/version.rb

@@ -1,3 +1,3 @@
 module TraxModel
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/trax_model.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "trax_core", "~> 0.0.3"
   spec.add_dependency "default_value_for", "~> 3.0.0"
+  spec.add_dependency "simple_enum"
   spec.add_development_dependency "activerecord"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
@@ -35,4 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-bundler', '~> 2'
   spec.add_development_dependency 'rb-fsevent'
   spec.add_development_dependency 'terminal-notifier-guard'
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trax_model
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Jason Ayre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-14 00:00:00.000000000 Z
+date: 2014-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trax_core
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: simple_enum
+  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: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -266,6 +280,7 @@ files:
 - lib/trax.rb
 - lib/trax/model.rb
 - lib/trax/model/config.rb
+- lib/trax/model/enum.rb
 - lib/trax/model/errors.rb
 - lib/trax/model/freezable.rb
 - lib/trax/model/matchable.rb
@@ -323,7 +338,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Higher level ActiveRecord models for rails