rails_services 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fc4964ed8a04bba20c8098d333195f81bfbf4f842ac09db9bac7113eca4f4c2
-  data.tar.gz: d0bc860c1bee886dd923ef379a728f8eaf7ba8c918092cc5026f6cc1a42d660f
+  metadata.gz: a03e068552adcb9e44d914b7387aee0823352a97344f5fedd2235769c9422d60
+  data.tar.gz: f4497409f14385d5dc43a31838aebbb634c545dcc4a1e9b589b76269e84b0219
 SHA512:
-  metadata.gz: c8c3fa58a147354c9f29b2a08192b0b20dc03090029c7d1f524db94cd0613a2d7e11e31badd6733f4451c840d3a0112766bfd5182a0a8fea4a551e4112ccdb39
-  data.tar.gz: a0b6f429baf0ef7cccbbbf3f31da12d1518e7b041d76276a6edbb25e4d4960d020691e15d6ada17cbf0b6f28eadac44c3cc8cae7da3068242dcef5f5a49a0ad0
+  metadata.gz: f140478c96620b1a44b90a06594ac4f376c9e97f0e970067cdcac4e30facecab51a4f6f75b2805492dd90ccb99fc19d97d8728490fa7e0ffc416fd25489db07b
+  data.tar.gz: f1361bdc5334403134e7989790abf87a68273d7592e3c1ac380581a3eeed4eea9e24671067357a7f61f75f7008af6e185df6a4062b619731490473d40ac6c150

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.0.1] - 2021-12-21
+### Added
+- Updated gem spec to just require Rails (no more specific versions)
+
+## [3.0.0] - 2020-04-12
+### Added
+- Added Form object option,
+- Updated for Rails 6
+
+## [2.5.0] - 2019-02-14
+### Fixed
+- Miscellaneous bug fixes
+
 ## [2.0.1] - 2017-07-16
 ### Added
 - Updating gem for the Rails verions 4 AND 5

data/README.md

@@ -1,17 +1,14 @@
 # RailsServices
 
 [![Code Climate](https://codeclimate.com/github/imageaid/rails_service_generator.png)](https://codeclimate.com/github/imageaid/rails_service_generator) 
-[![Test Coverage](https://codeclimate.com/github/imageaid/rails_service_generator/coverage.png)](https://codeclimate.com/github/imageaid/rails_service_generator)
 [![Gem Version](https://badge.fury.io/rb/rails_services.svg)](http://badge.fury.io/rb/rails_services)  
 
-A simple gem for Rails that adds a generator for easily creating a service class and/or form object and its accompanying spec or test unit file.
+A gem for Rails that adds a generator for easily creating a service class and/or form object and its accompanying spec or test unit file.
 
 ## Requirements 
-
 Rails 4 and higher
 
 ## Installation
-
 Add this line to your application's Gemfile:
 
     gem 'rails_services'
@@ -25,48 +22,55 @@ Or install it yourself as:
     $ gem install rails_services
 
 ## Usage
-
 Examples: 
 
-    $ rails generate rails_services:create Service Model|Controller --sub_folder Sub-folder [opt]
+    $ [bundle exec] rails generate rails_services:create Service ParentFolder --sub_folder SubFolder [opt]
     
-    $ rails generate rails_services:destroy Service Model|Controller --sub_folder Sub-folder [opt]
+    $ [bundle exec] rails generate rails_services:destroy Service ParentFolder --sub_folder SubFolder [opt]
     
-    $ rails generate rails_services:form Form Model|Controller --sub_folder Sub-folder [opt] --accessors name email [opt]
+    $ [bundle exec] rails generate rails_services:form Form ParentFolder --sub_folder SubFolder [opt] --accessors name email [opt]
+
+## v3.0.0 CHANGES AND REMOVALS   
+### CHANGES
+There are four primary changes in v3.0.0: 
 
-## CHANGES AND NOTES    
-### Notes: Sub-folders
-Sub-folders are optional but, at this time, you may only use one sub-folder. I generally use the sub-folders when I have a naturally grouped set of services.
+1. All services have `include BaseService` 
+2. The `call` method is an instance method rather than a class method
+3. You may generate a `Form` model
+4. An updated command line interface (see below)
 
-### Changes: new argument structure for the command line
-Previous versions of the gem used plain old arguments to create or destroy the appropriate files. Over time, this became
-more unwieldy than imagined. From version 3.0.0 forward, there are only two arguments: `object_name` and `parent_name`. 
+#### Updated command line interface
+Previous versions of the gem used plain old arguments to create or destroy the appropriate files. Over time, this became more unwieldy than imagined. From v3.0.0 forward, there are only two arguments: `object_name` and `parent_name`. Additionally, the previously available optional argument, `instance`, was removed (see REMOVALS section, below).
 
-If you would like to add a sub-folder to the service or form, you can now provide the `class_option` for it: 
-`--sub_folder NAME_OF_FOLDER`. Similarly, for the form generator, you can pass in an array of `attr_accessors` with 
-the following: `--accessors accessor_1_name accessor_2_name ...`. 
+If you would like to add a sub-folder to the service or form, you can now provide the `class_option` for it: `--sub_folder NAME_OF_FOLDER`. Similarly, for the form generator, you can pass in an array of `attr_accessors` with  the following: `--accessors accessor_1_name accessor_2_name ...` (use regular strings as these will be 'converted' to symbols). 
 
-### Changes: Instance Argument REMOVED
-An instance argument was added in version 2.0.0. While the version 2.x line allowed users to choose between the old and new style, 
-(new = service clases inherited from a `BaseService` class and instantiated the service), the version 3.x line removes this option. BE AWARE :). 
+### REMOVALS: 
+There was one significant removal from the gem: 
 
-## Upgrading
-There are two primary changes in version 3: 
+1. No more `instance` argument in the command line interface (see below)
 
-First, all services now include the `BaseService` class and methods in the services are, 
-by default, instance methods rather than class methods. 
+#### Instance argument dropped
+An instance argument was added in v2.0.0 which allowed users to choose what style of service class to create. The gem defaulted to using this new style. 
 
-Second, the gem now allows you to generate a `Form` object/model.  
+While the v2.x line continued to allow users a choice between the old and new^ styles, the v3.x line removes this choice. All services will be created with the now-not-so-new style. BE AWARE :)!
 
-**Converting Old Service Classes** - Should you want to update your older/previously built services with this approach, 
-you only need to do the following:
+^The new style creates service clases inherited from a `BaseService` class; allows for optional instantiation of the service (`Service.new(args*).call`), and uses an instance method for `call`. 
+
+## NOTES 
+### Upgrading to current service class style 
+Should you want to update your older/previously built services with this 'new' style, you only need to do the following:
 
      # include the base service in your class
      class ClassName
        include BaseService
 
-     # Then ... optionally, add an initialize method and 
-     # change the method signatures, simply removing self. from the definition(s)     
+     # Then ... optionally, add an initialize method 
+     def initialize(*args)
+       # ... 
+       super
+     end
+     
+     # Finally, change the method signatures, simply removing `self.` from the definition(s), as follows: 
      def self.call
        # ...
      end
@@ -76,28 +80,29 @@ you only need to do the following:
      end
      # and so on for other, similarly defined methods
 
-## Generator Result (create service and create form)
+### Sub-folders
+Sub-folders are optional but, at this time, you may only use one sub-folder. I generally only use the sub-folders when I have a naturally grouped set of services.
 
-Two files are created (spec or test based on your `test_framework`).
+## Generator results
+### Create service and create form
+Two files are created: the requested class and either a spec or test class, based on your testing framework (minitest or rspec).
 
 For services: 
 
-+ app/services/model|controller/[sub-folder]/thing.rb
-+ spec/services/model|controller/[sub-folder]/thing_spec.rb
-+ test/services/model|controller/[sub-folder]/thing_test.rb
++ app/services/[parent-folder]/[sub-folder]/thing.rb
++ spec/services/[parent-folder]/[sub-folder]/thing_spec.rb OR
++ test/services/[parent-folder]/[sub-folder]/thing_test.rb
 
 For forms: 
 
-+ app/forms/model|controller/[sub-folder]/thing_form.rb
-+ spec/forms/model|controller/[sub-folder]/thing_form_spec.rb
-+ test/forms/model|controller/[sub-folder]/thing_form_test.rb
++ app/forms/[parent-folder]/[sub-folder]/thing_form.rb
++ spec/forms/[parent-folder]/[sub-folder]/thing_form_spec.rb OR
++ test/forms/[parent-folder]/[sub-folder]/thing_form_test.rb
 
-## Generator Result (destroy service)
-
-Pretty simple here ... it just removes the files it created
+### Destroy service
+Pretty simple here ... it just removes the files it created!
 
 ## Contributing
-
 1. Fork it ( https://github.com/imageaid/rails_services/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/lib/rails_services/version.rb

@@ -1,3 +1,3 @@
 module RailsServices
-  VERSION = '3.0.0'.freeze
+  VERSION = '3.0.1'.freeze
 end

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rails_services
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Craig Kaminsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-12 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4'
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '4'
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -121,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A Ruby gem that adds a rails generator for creating service classes and form