enum-transition 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4326786bfdf9f0aa12df5a8ef184e5f50237c74db08cf56cfba2eeb4dc3a45e8
+  data.tar.gz: 7f7cd29ae5b67f1e4649c5e9ceb6d53e26e1a6db88beb5e38ffadc9eaeae4636
+SHA512:
+  metadata.gz: 6e7910cc48097e0c7555506ef410d1a071072f78a6e83742ef7a513a9153ae7c2b12c1a29b6e12dd69505fcc039435e10117f22a2218222c02a0f0075eb5caa8
+  data.tar.gz: 5cc0a1f8c17a33e4173ae8fbd915724c1eddd2ea52e431a00d6c8beeaa53e4aa89263ffd7a49835888badadf655ab693a6530f0507b874e9c2120f41191a629b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Snm Maurya
+
+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,46 @@
+# Enum::Transition
+Active Record ENUM based state machine. Whether you can control enum transation from one state to another state. Suppose you have an user model and you want to once user has been rejected he can't be verified, You can achive this job easily using this library.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enum-transition'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install enum-transition
+```
+
+## Usage
+
+```ruby
+# You have an user model and you want status transition should be verified or rejected from only initial
+
+class User
+  include Enum::Transition
+
+  enum status: {initial: 0, verified: 1, rejected: 2]
+
+  # Enum transition
+  enum_columns [:status]
+  enum_transitions :initial, [:verified, :rejected]
+end
+
+user = User.create(status: :initial)
+user.verified!
+user.rejected! # ActiveRecord::RecordInvalid: Validation failed: Status can't be changed from verified to rejected
+
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,33 @@
+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    = 'Enum::Transition'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/enum/transition.rb

@@ -0,0 +1,36 @@
+module Enum
+  module Transition
+    extend ActiveSupport::Concern
+
+    def self.included(base)
+      base.class_eval do
+        after_validation :ensure!
+        base.extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+      def enum_columns columns
+        instance_variable_set("@enum_columns_array", columns)
+      end
+
+      def enum_transitions from_transition, to_transitions
+        to_transitions.each do |to_transition|
+          define_method "#{from_transition}_to_#{to_transition}" do
+            true
+          end
+        end
+      end
+    end
+
+    def ensure!
+      self.class.name.constantize.instance_variable_get('@enum_columns_array').each do |column|
+        if !self.new_record?  && self.send("#{column}_changed?")
+          unless self.respond_to? "#{self.send("#{column}_was")}_to_#{self.send("#{column}")}"
+            self.errors.add(:base, "Status can't be changed from #{self.send("#{column}_was")} to #{self.send("#{column}")}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/enum/transition/version.rb

@@ -0,0 +1,5 @@
+module Enum
+  module Transition
+    VERSION = '0.1.0'
+  end
+end

data/lib/tasks/enum/transition_tasks.rake

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

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: enum-transition
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Snm Maurya
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.6.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+description: Active Record ENUM based state machine, whether you can restrict status
+  transition from one to other
+email:
+- snmmaurya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/enum/transition.rb
+- lib/enum/transition/version.rb
+- lib/tasks/enum/transition_tasks.rake
+homepage: https://www.github.com/snmmaurya/enum-transition
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Active Record ENUM based state machine
+test_files: []