nayati 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a733f07f8f3359c0684b55963a7fa0f728a51cb
-  data.tar.gz: 3190299bb8645a22130e302ba5d806c6c8f24555
+  metadata.gz: 5895a775d5ab307538361d102345d8a51fe586c4
+  data.tar.gz: c5dff7d34b4608012be012f75227fb692601f1cb
 SHA512:
-  metadata.gz: 188fee3b39c6dcfc2dd503c842fcbed19c1a8dafbfe5cb7fd46b926d7a13ba9451862eac0b211d29596a05e36f0e0d5d5bb181e57c37bd685555de49d82bbc56
-  data.tar.gz: bce2a551ad8d012b15ac65480d8d81131e8fe08f48c2274dd3836a0daab797e7d77ab0662286e0e9ccd00de561a37c665be2ce92c9515778213226f8abaa44f5
+  metadata.gz: 3390ec057e216347fc95e771ae7150a1432cf2e7a3aecfe42135f23320e123cbccc65d47cfc6fbbf014879563cb17b52d20dcb70fc4ec70a8bfe4456a07b70d4
+  data.tar.gz: bef30cec145ec40a6537af10674a0befaa86402106ed6a38bcd5ef7db1884addc0d819788a6a8f0c12562b64fbf59902a92e73c13d0fecfe306c4158403cfce2

data/README.md

@@ -1,5 +1,5 @@
 # Nayati
-Nayati is a Rails engine that helps in creating a clean and maintainable multi tenant Rails application. Creating multitenant application with Nayati allows you to have models that do just database talking and business logic gets handled by a layer I like to call 'Operation layer'. The sequence in which these operations get executed for a tenant is put in database.
+Nayati is a Rails engine that helps in creating a clean and maintainable multi tenant Rails application. Creating multitenant application with Nayati allows you to have models that do just database talking and don't hold much business logic. Business logic gets handled by a layer I like to call 'Operation layer'. The sequence in which these operations get executed for a tenant is put in database.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -21,12 +21,14 @@ First run the install generator
 ```bash
 $ rails generator nayati:install
 ```
+## How an app is structured using nayati
+
+![Image of nayati structure](https://github.com/tanmayforgit/nayati/blob/master/Nayati%20structure.png)
 
 ## How to use
 Nayati is meant to help in handling functional changes across tenants in your application.
 Lets say you have a attendance system. Your company installs devices which have fingerprint scanning functionality. Your clients vary from
-scools, gym, private companies. Now lets say you have 5 'operations' that can happen
-in this workflow viz marking_attendace, notify_parents, give_extra_marks_for_consistency, notify_sitting_position, late_marking, notify_missing_registration
+scools, gym, private companies. Now lets say you have 5 'operations' that can happen in this workflow viz., marking_attendace, notify_parents, give_extra_marks_for_consistency, notify_sitting_position, late_marking, notify_missing_registration
 notify_number_of_late_marks
 
 After installing, first generate a workflow e.g. attendance_management in example above.
@@ -51,6 +53,7 @@ $ rails generate nayati:operation attendance_management marking_attendance
 Next we will configure a workflow for a tenant. Lets say we are going to identify this workflow by name 'tenant_1_attendance_marking'. This tenant is a school and needs only marking_attendance and late_marking piece of functionality and if marking_attendance fails, you are supposed to nottify to register first. Nayati comes with a method to configure a workflow in database.
 
 workflow_hash corresponding to sequence mentioned in above paragraph would be
+```ruby
 workflow_sequence_hash = {
   name: 'marking_attendance',
   workflow_identifier: 'tenant_1_attendance_marking',
@@ -61,19 +64,29 @@ workflow_sequence_hash = {
     { name: 'late_marking'}
   ]
 }
+```
 
 You can put this workflow in database by calling
 ```ruby
 Nayati::Workflow.create_or_update_from_workflow_json(workflow_sequence_hash)
 ```
 
+If you want to print sequence of a workflow already in database you can do
+
+```ruby
+workflow_record.entire_workflow_as_hash
+```
+
+This will return a hash with a structure same as the one we used for creating workflow.
+
+
 Next we will have a look at operation class
-nayati:operation will generate operation class in app/nayati_operations/{workflow_name}/ directory which will automatically be initialized with operation_context that you created in nayati service class and result object when you call the 'call' method on service class.
 
-By default nayati will first call to_fail? method of a operation class. If this method returns true, nayati will call perform_failure and next operation will be after_failure operation configured in database. If this method returns false, nayati will call perform method and next operation will be after_success operation configured in database. Nayati will stop when there is no operation to run.
+nayati:operation generator will generate operation class in app/nayati_operations/{workflow_name}/ directory which will automatically be initialized with operation_context that you created in nayati service class and result object.
+
+Operation class implements to_fail?, perform_failure, perform methods. In our example marking_attendance operation should implement to_fail? in such a way that it returns false if fingerprint does not match. If not implemented, to_fail? by default returns false.
 
-## Sample
+By default nayati will first call to_fail? method of a operation class starting with initial operation. If this method returns true, nayati will call perform_failure and next operation will be after_failure operation configured in database. If this method returns false, nayati will call perform method and next operation will be after_success operation configured in database. Nayati will stop when there is no operation to run.
 
-You can find a sample multitenant application here.
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/nayati/version.rb

@@ -1,3 +1,3 @@
 module Nayati
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nayati
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tanmay Tupe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-02 00:00:00.000000000 Z
+date: 2020-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -34,22 +34,16 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement