snm-enum-transition 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 553f66e61a7a58bbc3d64fa123f903e8f0e416a600f2d0313766bc35c9e00358
+  data.tar.gz: 1740b4d0b5f255e6f9d7674eb86f56c3345f73a4add555c23b6f120981e4819d
+SHA512:
+  metadata.gz: 7d894a61696c6b7139c85f1cbbb8ce4e610840124973a08fdf2dc9a82a0b242f0b59c76aa692f55f5f513b033be990d1547846d9c88e35f140b5c3a32cf065ff
+  data.tar.gz: dad1895e522b52acdef011088ea7c5822495b6f42e0f1f35ba160236a0462ba852c077cc41367fe667d6c5044ae72256a9a7f1360cae24e88b58e6d5fd25b8c8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2024 snmmaurya
+
+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,61 @@
+# Snm::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 "snm-enum-transition"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install snm-enum-transition
+```
+
+## Usage
+
+```ruby
+
+# You have an user model and you want to specify status transitions: initial to verified, initial to rejected and rejected to initial
+
+
+class User
+  include Snm::Enum::Transition
+
+  enum status: {initial: 0, verified: 1, rejected: 2]
+
+  # Specify (allow enum transition) column name, from and to
+  snm_enum_transitions :status, :initial, [:verified, :rejected]
+  snm_enum_transitions :status, [:rejected], [:initial]
+end
+
+user = User.create(status: :initial)
+
+
+# IF user status is initial
+user.verified! # Okay
+user.rejected! # Okay
+
+# IF user status is verified
+user.rejected! # ActiveRecord::RecordInvalid: Validation failed: Status can't be changed from verified to rejected
+user.initial! # ActiveRecord::RecordInvalid: Validation failed: Status can't be changed from verified to initial
+
+# IF user status is rejected
+user.initial! # Okay
+user.verified! # ActiveRecord::RecordInvalid: Validation failed: Status can't be changed from rejected to verified
+
+```
+
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/snmmaurya/snm-enum-transition. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/snm/enum/transition/railtie.rb

@@ -0,0 +1,8 @@
+module Snm
+  module Enum
+    module Transition
+      class Railtie < ::Rails::Railtie
+      end
+    end
+  end
+end

data/lib/snm/enum/transition/version.rb

@@ -0,0 +1,7 @@
+module Snm
+  module Enum
+    module Transition
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/snm/enum/transition.rb

@@ -0,0 +1,42 @@
+require "snm/enum/transition/version"
+require "snm/enum/transition/railtie"
+
+module Snm
+  module Enum
+    module Transition
+      extend ActiveSupport::Concern
+
+      def self.included(base)
+        base.class_eval do
+          validate :ensure!
+          base.extend ClassMethods
+          @enum_transition_columns=[]
+        end
+      end
+
+      module ClassMethods
+        def snm_enum_transitions column_name, from_transitions, to_transitions
+          from_transitions.each do |ft|
+            to_transitions.each do |tt|
+              define_method ("snm_#{ft}_to_#{tt}") do
+                true
+              end
+            end
+          end
+          @enum_transition_columns.push(column_name).uniq!
+        end
+      end
+
+      def ensure!
+        self.class.name.constantize.instance_variable_get('@enum_transition_columns').each do |column|
+          if !self.new_record?  && self.send("#{column}_changed?")
+            unless self.respond_to? "snm_#{self.send("#{column}_was")}_to_#{self.send("#{column}")}"
+              self.errors.add(:base, "#{column.capitalize} can't be changed from #{self.send("#{column}_was")} to #{self.send("#{column}")}")
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/tasks/snm/enum/transition_tasks.rake

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

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: snm-enum-transition
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- snmmaurya
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.8.4
+description: 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.
+email:
+- snmspace@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/snm/enum/transition.rb
+- lib/snm/enum/transition/railtie.rb
+- lib/snm/enum/transition/version.rb
+- lib/tasks/snm/enum/transition_tasks.rake
+homepage: https://github.com/snmmaurya/snm-enum-transition
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/snmmaurya/snm-enum-transition
+  source_code_uri: https://github.com/snmmaurya/snm-enum-transition
+  changelog_uri: https://github.com/snmmaurya/snm-enum-transition
+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: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Active Record ENUM based state machine
+test_files: []