rails_services 1.1.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3fe343adaad795fb7f453ab2c090689efb39f80
-  data.tar.gz: b22a7f31227a1ed96b763ce420e315d7d1f6e5ca
+  metadata.gz: 9ed6fbb385562ade48621df44d26cc9a792f2e8a
+  data.tar.gz: 8584883d0e3aedc95d8c824b340d0e020d671831
 SHA512:
-  metadata.gz: 10364abcef2b2def89dd724f7bbf6b687b2e6f14556ed28ec97fa489293b3a0962cc9d3366d5eeccfff75046ed14713bc3a7cfbed424b1cc3fae4ff8c526e169
-  data.tar.gz: 51d82ba5ab02a6257ed228a0bdd016e7f686fc9203960fec2dc52957993eb406c4990971f9012ee918e928e96d605db6c45a8480f7d2a6e6d604aa4004ef695e
+  metadata.gz: c926ddb834d4b593e5f4a1871bc614c202b9663cd07bee5ed6979348936c7f036ff3a38f3c76281c7eb9adaafbe8cfa9d020f9dce77176bc79600d11bd9171a8
+  data.tar.gz: e20de587c99ca41564f44d7dd6a1ae7d6485c31e7f4355729915341eae1bc0dd9336ee56478018c85a022f66e5163c23059e457c568bdd1f2592944c34932e88

data/README.md

@@ -8,7 +8,7 @@ A very (VERY) simple gem for Rails that adds a generator for easily creating a s
 
 ## Requirements 
 
-Rails 4.2.0 and higher
+Rails 4 and higher
 
 ## Installation
 
@@ -28,11 +28,43 @@ Or install it yourself as:
 
 Examples: 
 
-    $ rails generate rails_services:create Service Model|Controller Sub-folder [opt]
+    $ rails generate rails_services:create Service Model|Controller Sub-folder [opt] --instance [yes (default), no]
     
-    $ rails generate rails_services:destroy Service Model|Controller Sub-folder [opt]
+    $ rails generate rails_services:destroy Service Model|Controller Sub-folder [opt] --instance [yes (default), no]
     
-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.     
+### 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.
+
+### Instance Argument
+The instance argument was added in version 2.0.0. It is also optional but does default to `yes` if omitted. In previous iterations of this gem
+as well as in my early use of service layers, I did not instantiate my service classes; rather, I created adn accessed them at the class level,
+calling class methods (i.e., those defined with `self.`).
+
+I was never satisfied with this and, sometime in the last few months, I read a now-lost blog post on utilizing a `BaseService` class and
+instantiating your actual service. I prefer this new approach, for lack of a better word, and have decided to add it to this gem, as the
+default style used going forward (starting with 2.0.0).
+
+## Upgrading
+The primary change in version 2 is that old services, those that do not include the `BaseService` class, called
+and accessed methods that were all defined with `self.`. You do not have to choose one style over another; in fact,
+you can mix and match the styles, if you wish.
+
+**Converting Old Service Classes** - Should you want to update your older/previously built services with this approach, you only need to do
+the following:
+
+     # include the base service in your class
+     class ClassName
+       include BaseService
+
+     # Then ... change the method signatures, simply removing "self." from the definition
+     def self.call
+       # ...
+     end
+     # becomes
+     def call
+       # ...
+     end
+     # and so on for other, similarly defined methods
 
 ## Result
 

data/lib/generators/rails_services/USAGE

@@ -1,16 +1,27 @@
 Description:
-    Creates a service class and accompanying spec file
-    Destroys a service class and accompanying spec file
+    Creates a service class and accompanying spec/test unit file
+    Destroys a service class and accompanying spec/test unit file
 
 Example:
-    rails generate rails_services:destroy Thing Model|Controller Sub-folder [opt]
+    rails generate rails_services:destroy Thing Model|Controller Sub-folder [opt] --instance [yes (default), no]
 
     This will remove:
         app/services/model|controller/[sub-folder]/thing.rb
+        # either
         spec/services/model|controller/[sub-folder]/thing_spec.rb
+        # or
+        test/services/model|controller/[sub-folder]/thing_test.rb
 
-    rails generate rails_services:create Thing Model|Controller Sub-folder [opt]
+    rails generate rails_services:create Thing Model|Controller Sub-folder [opt] --instance [yes (default), no]
 
     This will add:
         app/services/model|controller/[sub-folder]/thing.rb
-        spec/services/model|controller/[sub-folder]/thing_spec.rb
+        # either
+        spec/services/model|controller/[sub-folder]/thing_spec.rb
+        # or
+        test/services/model|controller/[sub-folder]/thing_test.rb
+
+The new `instance` argument:
+    Over the last year, I have slightly altered how I structure my service classes. I've taken to using a `BaseService`
+    class that is included in all services. This allows me to inherently instantiate each service (versus the old style of
+    creating service class, which was "class-driven", if you will).

data/lib/generators/rails_services/create_generator.rb

@@ -5,13 +5,23 @@ module RailsServices
       argument :service_name, type: :string
       argument :parent_name, type: :string
       argument :sub_folder, type: :string, default: ''
+      argument :instance, type: :string, default: 'yes'
 
       def create_service
-        template 'base_service.rb.erb', "app/services/#{service_directory}/#{service_file}"
+        if instance == 'yes'
+          copy_base_service_class
+          template 'base_service_new.rb.erb', "app/services/#{service_directory}/#{service_file}"
+        else
+          template 'base_service_old.rb.erb', "app/services/#{service_directory}/#{service_file}"
+        end
         create_test
       end
 
       private
+      def copy_base_service_class
+        template('base_service.rb.erb', 'app/services/base_service.rb') unless File.exist?('app/services/base_service.rb')
+      end
+
       def create_test
         if File.exists?('spec/spec_helper.rb')
           template 'base_service_spec.rb.erb', "spec/services/#{service_directory}/#{spec_file}"

data/lib/generators/rails_services/templates/base_service.rb.erb

@@ -1,13 +1,12 @@
-<%= "module #{module_name}" %>
-<% if subfolder_name.present? %>
-  <%= "module #{subfolder_name}" %>
-<% end  %>
-    <%= "class #{class_name}" %>
-      <%= "# SAMPLE USAGE: #{qualified_name}.call(*args)" %>
-      <%= 'def self.call' %>
-      <%= 'end' %>
+<%= 'module BaseService' %>
+  <%= 'def self.included(base)' %>
+    <%= 'base.extend ClassMethods' %>
+  <%= 'end' %>
+
+  <%= 'module ClassMethods' %>
+    <%= 'def call(*args, &block)' %>
+      <%= '@instance ||= self.new' %>
+      <%= '@instance.call *args, &block' %>
     <%= 'end' %>
-<% if subfolder_name.present? %>
   <%= 'end' %>
-<% end  %>
 <%= 'end' %>

data/lib/generators/rails_services/templates/base_service_new.rb.erb

@@ -0,0 +1,23 @@
+<%= "module #{module_name}" %>
+<% if subfolder_name.present? %>
+  <%= "module #{subfolder_name}" %>
+<% end  %>
+<% if subfolder_name.present? %>
+    <%= "class #{class_name}" %>
+      <%= 'include BaseService' %>
+      <%= "# SAMPLE USAGE: #{qualified_name}.(*args)" %>
+      <%= 'def call' %>
+      <%= 'end' %>
+    <%= 'end' %>
+<% else %>
+  <%= "class #{class_name}" %>
+    <%= 'include BaseService' %>
+    <%= "# SAMPLE USAGE: #{qualified_name}.(*args)" %>
+    <%= 'def call' %>
+    <%= 'end' %>
+  <%= 'end' %>
+<% end  %>
+<% if subfolder_name.present? %>
+  <%= 'end' %>
+<% end  %>
+<%= 'end' %>

data/lib/generators/rails_services/templates/base_service_old.rb.erb

@@ -0,0 +1,21 @@
+<%= "module #{module_name}" %>
+<% if subfolder_name.present? %>
+  <%= "module #{subfolder_name}" %>
+<% end  %>
+<% if subfolder_name.present? %>
+    <%= "class #{class_name}" %>
+      <%= "# SAMPLE USAGE: #{qualified_name}.call(*args)" %>
+      <%= 'def self.call' %>
+      <%= 'end' %>
+    <%= 'end' %>
+<% else %>
+  <%= "class #{class_name}" %>
+    <%= "# SAMPLE USAGE: #{qualified_name}.call(*args)" %>
+    <%= 'def self.call' %>
+    <%= 'end' %>
+  <%= 'end' %>
+<% end  %>
+<% if subfolder_name.present? %>
+  <%= 'end' %>
+<% end  %>
+<%= 'end' %>

data/lib/rails_services/version.rb

@@ -1,3 +1,3 @@
 module RailsServices
-  VERSION = '1.1.3'
+  VERSION = '2.0.0'
 end

data/test/lib/generators/rails_services/create_generator_test.rb

@@ -7,11 +7,17 @@ class CreateGeneratorTest < Rails::Generators::TestCase
 
   setup do
     prepare_destination
-    run_generator(%w(TestService ParentModel SubFolder))
   end
 
-  test 'generates a service class' do
+  test 'generates an old style service class' do
+    run_generator(%w(TestService ParentModel SubFolder --style old))
     assert_file 'app/services/parent_models/sub_folder/test_service.rb'
   end
 
+  test 'generates a new style service class' do
+    run_generator(%w(TestBaseService ParentModel SubFolder --style new))
+    assert_file 'app/services/base_service.rb'
+    assert_file 'app/services/parent_models/sub_folder/test_base_service.rb'
+  end
+
 end

data/test/test_helper.rb

@@ -10,6 +10,7 @@ require 'minitest/autorun'
 require 'minitest/reporters'
 require 'minitest/pride'
 
+MiniTest::Reporters.use!
 
 class MiniTest::Unit::TestCase
   ActiveSupport::TestCase.test_order = :random

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_services
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Craig Kaminsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-03 00:00:00.000000000 Z
+date: 2016-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -81,6 +81,8 @@ files:
 - lib/generators/rails_services/create_generator.rb
 - lib/generators/rails_services/destroy_generator.rb
 - lib/generators/rails_services/templates/base_service.rb.erb
+- lib/generators/rails_services/templates/base_service_new.rb.erb
+- lib/generators/rails_services/templates/base_service_old.rb.erb
 - lib/generators/rails_services/templates/base_service_spec.rb.erb
 - lib/generators/rails_services/templates/base_service_unit_test.rb.erb
 - lib/rails_services.rb