jt-rails-enum 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c87dea8a69c0c7c01c8b4886a1023854f04eedaf
-  data.tar.gz: a84469d4627dcb5e7abd3bbfb1c438710990565a
+  metadata.gz: ca5be5149ec48c4e3f647633c7fc82afb7b1f1b1
+  data.tar.gz: ab1bbe3192442aa030c7f11b222659dd190599cd
 SHA512:
-  metadata.gz: a94a3ab8b26e15f28e078a85a0ec7ba0787d70e6bb84d11cbd9204cb99f48b0a25045cafd14b712b367665bed78d5797cbf36ae2483eeb048b2e2ac8982233aa
-  data.tar.gz: c3e8e09e89bd73b3ee5b900c38fa024b3a58fea84bb91805bee7d027e3ef129704c16026e7206a8d85c0c0021a186c5dbcd33d56bae35fea4538cde879c7d530
+  metadata.gz: 463c6a1d8c18fc548288dffda6a4ad3860112a463719241e2ca84af6efa2667240523ead8fdd7d08cdd47a18a1e4425fba343ca9721f27fd2a7263382455b334
+  data.tar.gz: 147fcb38b49c3c13d3cd273667525ca95356ae78baec8ff7989d116c18e34d43c3e05f6547ac920368a8e14d995bfedb49024630bc65b96acd926d3100242cf2

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.DS_Store

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2016 Jonathan Tribouharet
+
+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,50 @@
+# JTRailsEnum
+
+[![Gem Version](https://badge.fury.io/rb/jt-rails-enum.svg)](http://badge.fury.io/rb/jt-rails-enum)
+
+JTRailsEnum let you use enum in your models. JTRailsEnum doesn't works exactly like `enum` in Ruby On Rails. It always add a prefix, which is a better behavior when you use multiple enums in a model. The `prefix` option is also not present in the Ruby On Rails 4.0.
+
+## Installation
+
+JTRailsEnum is distributed as a gem, which is how it should be used in your app.
+
+Include the gem in your Gemfile:
+
+    gem 'jt-rails-enum', '~> 1.0'
+
+## Usage
+
+### Basic usage
+
+```ruby
+class User < ActiveRecord::Base
+
+    jt_enum confirmation_status: [
+        :waiting,
+        :accepted,
+        :refused
+    ]
+
+end
+```
+
+Scopes and some basic methods are automatically created for each value in the enum.
+```ruby
+# User.where(confirmation_status: User.confirmation_statuses[:waiting]).first
+user = User.confirmation_status_waiting.first
+
+# Equivalent to user.update!(confirmation_status: User.confirmation_statuses[:accepted])
+user.confirmation_status_accepted!
+
+# Equivalent to user.confirmation_status == User.confirmation_statuses[:accepted]
+user.confirmation_status_accepted?
+
+```
+
+## Author
+
+- [Jonathan Tribouharet](https://github.com/jonathantribouharet) ([@johntribouharet](https://twitter.com/johntribouharet))
+
+## License
+
+JTRailsEnum is released under the MIT license. See the LICENSE file for more info.

data/jt-rails-enum.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+	s.name = 'jt-rails-enum'
+	s.summary = "JTRailsEnum let you use enum in your models"
+	s.description = "JTRailsEnum let you use enum in your models"
+	s.homepage = 'https://github.com/jonathantribouharet/jt-rails-enum'
+	s.version = '1.0.1'
+	s.files = `git ls-files`.split("\n")
+	s.require_paths = ['lib']
+	s.authors = ['Jonathan TRIBOUHARET']
+	s.email = 'jonathan.tribouharet@gmail.com'
+	s.license = 'MIT'
+	s.platform = Gem::Platform::RUBY
+end

data/lib/jt-rails-enum.rb

@@ -0,0 +1,37 @@
+module JT
+	module Rails
+		module Enum
+			extend ActiveSupport::Concern
+
+			class_methods do
+
+				def jt_enum(definitions)
+					klass = self
+
+					definitions.each do |field, values|
+
+						enum_values = ActiveSupport::HashWithIndifferentAccess.new
+
+						klass.singleton_class.send(:define_method, field.to_s.pluralize) { enum_values }
+
+						values.each_with_index do |value, i|
+							value_method_name = "#{field}_#{value}"
+
+							enum_values[value] = i
+
+							define_method("#{value_method_name}?") { self[field] == i }
+							define_method("#{value_method_name}!") { update! field => i }
+
+							klass.scope value_method_name, -> { klass.where field => i }
+						end
+
+						validates field, allow_nil: true, inclusion: { in: klass.send(field.to_s.pluralize).values } 
+
+					end
+				end
+			end
+		end
+	end
+end
+
+ActiveRecord::Base.send :include, JT::Rails::Enum

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jt-rails-enum
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jonathan TRIBOUHARET
@@ -15,7 +15,13 @@ email: jonathan.tribouharet@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- jt-rails-enum.gemspec
+- lib/jt-rails-enum.rb
 homepage: https://github.com/jonathantribouharet/jt-rails-enum
 licenses:
 - MIT