enum_ext 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ffa90e0370f3f30ab49c181e22ae0912d145f13
-  data.tar.gz: eddf18cc4c9387c5598725692659fff237ab8d56
+  metadata.gz: 28a9c98466010b9ab1ce952a1adbeb9359967189
+  data.tar.gz: 39445759f6344b716081517f51e5072fe966cc5f
 SHA512:
-  metadata.gz: 508e8720112409a3a3f68ff4274e09d8900a68e6154d921b5c2009e5cc599f9cefb3d621ac091a0d7dddd5363b49fedf5a28e36b3688285494768f21bfc36cc8
-  data.tar.gz: 65ff47b4104d223e663e6db03660a4d2c6378560fc174f5720ecd172c86f0045b60cc8130b99b29c1909a99aecb6ec6e05fc124c6180f451532dd88cc87e7e25
+  metadata.gz: f13183dbbd1e2a91f083c1d75dcffe0096069766d85f10ee6d0a23808b9dfa56713c30050f486199efa993549ad3c5770cb28366c1dfcc45fdd816b729b4df51
+  data.tar.gz: b06cec1f9fd1a3fdffc35257b0538e3a8b30d49c257a856ca088ffd180bee84a28744b3b4300c8cb6514ac7c8f7f8d2d77f1f6040b41fb8e9e71a4ff7c9f9511

data/.gitignore

@@ -0,0 +1 @@
+.idea/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    enum_ext (0.1.1)
+      activerecord (>= 4.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.5)
+      activesupport (= 4.2.5)
+      builder (~> 3.1)
+    activerecord (4.2.5)
+      activemodel (= 4.2.5)
+      activesupport (= 4.2.5)
+      arel (~> 6.0)
+    activesupport (4.2.5)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.3)
+    rake (10.4.2)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  enum_ext!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 alekseyl
+
+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,200 @@
+# EnumExt
+
+EnumExt extends rails enum adding localization template, mass-assign on scopes with bang and some sets logic over existing enum.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enum_ext'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enum_ext
+
+## Usage
+
+ Let's assume we have model Request with enum *status*, and we have model Order with requests like this:
+
+     class Request
+       extend EnumExt
+       belongs_to :order
+       enum status: [ :in_cart, :waiting_for_payment, :payed, :ready_for_shipment, :on_delivery, :delivered ]
+     end
+
+     class Order
+       has_many :requests
+     end
+
+ Now let's review some examples of possible enum extensions
+
+### Localization (localize_enum) 
+  
+     class Request
+      ...
+      localize_enum :status, {
+    
+         #locale dependent example ( it dynamically use current locale ):
+         in_cart: -> { I18n.t("request.status.in_cart") },
+    
+         #locale dependent example with internal pluralization:
+         payed: -> (t_self) { I18n.t("request.status.payed", count: t_self.sum ) }
+    
+         #locale independent:
+         ready_for_shipment: "Ready to go!" 
+       }
+     end
+
+Console:
+
+       request.sum = 3
+       request.payed!
+       request.status      # >> payed
+       request.t_status    # >> "Payed 3 dollars"
+       Request.t_statuses  # >> { in_cart: -> { I18n.t("request.status.in_cart") }, ....  }
+
+If you need some substitution you can go like this:
+
+       localize_enum :status, {
+             ..
+        delivered: "Delivered at: %{date}"
+       }
+       request.delivered!
+       request.t_status % {date: Time.now.to_s}  >> Delivered at: 05.02.2016
+
+If you need select status on form and so:
+    
+        f.select :status, Request.t_statuses.invert.to_a
+
+
+### Enum Sets (ext_enum_sets)
+
+ This method intended for creating and using some sets of enum values with similar to original enum syntax. 
+ 
+ **Use-case** For example you have pay bills of different types, and you want to group some types in debit and credit "super-types", and have scope PayBill.debit, instance method with question mark as usual enum does pay_bill.debit? and so.
+ 
+ You can do this with method **ext_enum_sets**, it creates: scopes for subsets like enum did, instance method with ? similar to enum methods, and so...
+ 
+ I strongly recommend you to create the comment near method call, to remember what methods will be defined
+  
+      class Request
+            ...
+           #instance non_payed?, delivery_set?, in_warehouse?
+           #class scopes: non_payed, delivery_set, in_warehouse
+           #class scopes: with_statuses, without_statuses
+           #class non_payed_statuses, delivery_set_statuses ( = [:in_cart, :waiting_for_payment], [:ready_for_shipment, :on_delivery, :delivered].. )
+           
+           ext_enum_sets :status, {
+                           non_payed: [:in_cart, :waiting_for_payment],
+                           delivery_set: [:ready_for_shipment, :on_delivery, :delivered]  for shipping department for example
+                           in_warehouse: [:ready_for_shipment]                            it's just for example below
+                         }
+      end
+
+Console:
+
+        request.waiting_for_payment!
+        request.non_payed?                     # >> true
+        
+        Request.non_payed.exists?(request)     # >> true
+        Request.delivery_set.exists?(request)  # >> false
+        
+        Request.non_payed_statuses             # >> [:in_cart, :waiting_for_payment]
+        
+        Request.with_statuses( :payed, :in_cart )       # >> scope for all in_cart and payed requests
+        Request.without_statuses( :payed )              # >> scope for all requests with statuses not eq to payed
+        Request.without_statuses( :payed, :non_payed )  # >> scope all requests with statuses not eq to payed and in_cart + waiting_for_payment
+
+
+#### Rem:
+
+You can call ext_enum_sets more than one time defining a superposition of already defined sets:
+
+      class Request
+        ...
+        ext_enum_sets (... first time you call ext_enum_sets )
+        ext_enum_sets :status, {
+                          already_payed: ( [:payed] | delivery_set_statuses ),
+                          outside_wharehouse: ( delivery_set_statuses - in_warehouse_statuses )... # any other array operations like &, + and so can be used
+                       }
+
+### Mass-assign ( mass_assign_enum )
+ 
+ Syntax sugar for mass-assigning enum values. 
+ 
+ **Use-case:** it's often case when I need bulk update without callbacks, so it's gets frustrating to repeat: some_scope.update_all(status: Request.statuses[:new_status], update_at: Time.now)
+ If you need callbacks you can do like this: some_scope.each(&:new_stat!) but if you don't need callbacks and you has hundreds and thousands of records to change at once you need update_all
+
+     class Request
+       ...
+       mass_assign_enum( :status )
+     end
+
+ Console:
+ 
+        request1.in_cart!
+        request2.waiting_for_payment!
+        Request.non_payed.payed!
+        request1.payed?                         # >> true
+        request2.payed?                         # >> true
+        request1.updated_at                     # >> ~ Time.now
+        Request.respond_to?('::MassAssignEnum') # >> true
+        
+        order.requests.already_payed.all?(&:already_payed?)  # >> true
+        order.requests.already_payed.delivered!
+        order.requests.map(&:status).uniq                   # >> [:delivered]
+
+
+####Rem:
+
+ **mass_assign_enum** accepts additional options as last argument. Calling  
+ 
+    mass_assign_enum( :status ) 
+ 
+ actually is equal to call:
+  
+    mass_assign_enum( :status, { relation: true, association_relation: true } )
+
+###### Meaning:
+
+ relation: true - Request.some_scope.payed! - works
+
+ association_relation: true - Order.first.requests.scope.new_stat! - works
+ 
+ **but it wouldn't works without 'scope' part!** If you want to use it without 'scope' you may do it this way:
+ 
+     class Request
+       ...
+       mass_assign_enum( :status, association_relation: false )
+     end
+
+     class Order
+      has_many :requests, extend: Request::MassAssignEnum
+     end
+    
+     Order.first.requests.respond_to?(:in_cart!)  # >> true
+
+#### Rem2:
+ You can mass-assign more than one enum ::MassAssignEnum module will contain mass assign for both. It will break nothing since all enum name must be uniq across model
+
+## Tests
+ Right now goes without automated tests :(
+ 
+## Development
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alekseyl/enum_ext or by email: leshchuk@gmail.com
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/enum_ext.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enum_ext/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "enum_ext"
+  spec.version       = EnumExt::VERSION
+  spec.authors       = ["alekseyl"]
+  spec.email         = ["leshchuk@gmail.com"]
+
+  spec.summary       = %q{Enum extension, ads enum sets, mass-assign for them, localization for them.}
+  spec.description   = %q{Enum extension, ads enum sets, mass-assign for them, localization for them.}
+  spec.homepage      = "https://github.com/alekseyl/enum_ext"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">=4.1"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/enum_ext/version.rb

@@ -0,0 +1,3 @@
+module EnumExt
+  VERSION = "0.1.1"
+end

data/lib/enum_ext.rb

@@ -1,3 +1,5 @@
+require "enum_ext/version"
+
 # Let's assume we have model Request with enum status, and we have model Order with requests like this:
 # class Request
 #   extend EnumExt

metadata

@@ -1,23 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: enum_ext
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
-- Leshchuk Alexey
+- alekseyl
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 2016-02-22 00:00:00.000000000 Z
-dependencies: []
-description: Some sugar extention for rails enum
-email: leshchuk@gmail.com
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: Enum extension, ads enum sets, mass-assign for them, localization for
+  them.
+email:
+- leshchuk@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- enum_ext.gemspec
 - lib/enum_ext.rb
-homepage: http://rubygems.org/gems/hola
+- lib/enum_ext/version.rb
+homepage: https://github.com/alekseyl/enum_ext
 licenses:
 - MIT
 metadata: {}
@@ -40,5 +92,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Enum extention!
+summary: Enum extension, ads enum sets, mass-assign for them, localization for them.
 test_files: []