command_service_object 0.4.0 → 0.5.0

data/lib/generators/service/getter/templates/getter.rb.erb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module <%= service_name.classify %>::Usecases::Getters
+  class <%= @getter %>
+    def call(*args)
+    end
+  end
+end

data/lib/generators/service/install/install_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+
+module Service
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def create_initializer_file
+        template 'initializer.rb', config_file_path
+      end
+
+      def create_services_dir
+        directory 'services', 'app/services'
+      end
+
+      private
+
+      def config_file_path
+        'config/initializers/command_service_object.rb'
+      end
+    end
+  end
+end

data/lib/generators/service/install/templates/initializer.rb

@@ -0,0 +1,19 @@
+CommandServiceObject.configure do |config|
+  # By setting the append_controller_helper to false you will need to
+  # manually include the CommandServiceObject::ServiceControllerHelper
+  # module to your base controller.
+  # config.append_controller_helper = true
+  #
+  # The default command method name is :command
+  # but you can easily rename it to avoid collisions.
+  # config.command_method_name = :command
+  #
+  # Skip the generation of commands by the rails g service command
+  # config.skip_command = false
+  #
+  # Skip the generation of minitest/rspec by the rails g service command
+  # config.skip_test = false
+  #
+  # Skip the generation of errors by the rails g service command
+  # config.skip_error = true
+end

data/lib/generators/service/install/templates/services/application_service.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class ApplicationService
+  class << self
+    def call(cmd)
+      raise Errors::InvalidCommand, cmd.class if cmd.invalid?
+
+      usecase = usecase_for(cmd).new(cmd)
+      usecase.call
+    rescue StandardError => e
+      if usecase
+        usecase.rollback_setters
+        usecase.rollback
+      end
+      handle_failure(e)
+      raise e
+    end
+
+    def handle_failure(failure)
+      # don't log custom failures if you want :D
+      return if failure.class.is_a?(CommandServiceObject::Failure)
+      #
+      # Add your logging logic
+      # ex:
+      #   Rollbar.error(failure)
+      #
+    end
+
+    private
+
+    def usecase_for(cmd)
+      cmd.class.name.gsub('Commands', 'Usecases').constantize
+    end
+  end
+end

data/lib/generators/service/install/templates/services/case_base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class CaseBase
+  include CommandServiceObject::FailureHelper
+
+  attr_reader :payload
+
+  def initialize(payload)
+    @payload = payload
+  end
+
+  def rollback; end
+end

data/lib/generators/service/service_generator.rb

@@ -1,114 +1,50 @@
 # frozen_string_literal: true
 
 require 'rubygems'
+require_relative './setup/setup_generator.rb'
+require_relative './usecase/usecase_generator.rb'
+require_relative './command/command_generator.rb'
+require_relative './test/test_generator.rb'
+require 'rails/generators'
 require 'rails/generators/model_helpers'
 
-class ServiceGenerator < Rails::Generators::NamedBase
-  include Rails::Generators::ModelHelpers
+module Service
+  module Generators
+    class ServiceGenerator < Rails::Generators::NamedBase
+      argument :usecases, type: :array, default: [], banner: 'usecase usecase'
 
-  source_root File.expand_path('templates', __dir__)
+      # Skiping options
+      class_option :skip_usecase, type: :boolean, default: false, aliases: '-U'
+      class_option :skip_command, type: :boolean, default: false, aliases: '-C'
+      class_option :skip_test,    type: :boolean, default: false, aliases: '-T'
 
-  argument :usecases, type: :array, default: [], banner: 'usecase usecase'
-  class_option :skip_command, type: :boolean, default: false, aliases: '-C',
-                              desc: 'skip command file generation'
-  class_option :skip_error, type: :boolean, default: false, aliases: '-E',
-                            desc: 'skip error file generation'
-  class_option :skip_test, type: :boolean, default: false, aliases: '-T',
-                           desc: 'skip test file generation'
+      def install_if_not
+        return if File.exist?('app/services')
 
-  def create_base_dir
-    return if File.exist?('app/services')
+        generate 'service:install'
+      end
 
-    directory 'base', 'app/services'
-  end
+      def setup
+        invoke Service::Generators::SetupGenerator, [name]
+      end
 
-  def add_controller_helper_to_application_controller
-    application_controller_path = 'app/controllers/application_controller.rb'
+      def generate_usecases
+        return if options.skip_usecase?
 
-    line = File.readlines(application_controller_path).select do |li|
-      li =~ /class ApplicationController </
-    end.first
+        invoke Service::Generators::UsecaseGenerator, [name, usecases]
+      end
 
-    inject_into_file application_controller_path, after: line do
-      "  include ServiceControllerHelper\n"
-    end
-  end
+      def generate_commands
+        return if options.skip_command?
 
-  def add_virtus_gem_to_gemfile
-    gem 'virtus'
-  end
+        invoke Service::Generators::CommandGenerator, [name, usecases]
+      end
 
-  def create_service_dir
-    return if File.exist?("app/services/#{service_name}")
+      def generate_tests
+        return if options.skip_test?
 
-    empty_directory("app/services/#{service_name}")
-    empty_directory("app/services/#{service_name}/usecases")
-    empty_directory("app/services/#{service_name}/commands")
-    empty_directory("app/services/#{service_name}/errors")
-  end
-
-  def generate_usecases
-    usecases.each do |usecase|
-      generate_usecase(usecase)
-      generate_command(usecase)
-      generate_error(usecase)
-      generate_test(usecase)
+        invoke Service::Generators::TestGenerator, [name, usecases]
+      end
     end
   end
-
-  private
-
-  def generate_usecase(usecase)
-    @usecase = usecase.classify
-    path = "app/services/#{service_name}/usecases/#{usecase.underscore}.rb"
-    template 'usecase.rb.erb', path
-  end
-
-  def generate_command(command)
-    @command = command.classify
-    path = "app/services/#{service_name}/commands/#{command.underscore}.rb"
-    template 'command.rb.erb', path unless options.skip_command?
-  end
-
-  def generate_error(error)
-    @error = error.classify
-    path = "app/services/#{service_name}/errors/#{error.underscore}.rb"
-    template 'error.rb.erb', path unless options.skip_error?
-  end
-
-  def generate_test(test)
-    return if options.skip_test?
-
-    if defined?(Minitest)
-      empty_directory('test/services')
-      generate_minitest_test_files(test)
-    elsif defined?(RSpec)
-      empty_directory('spec/services')
-      generate_rspec_test_files(test)
-    end
-  end
-
-  def generate_minitest_test_files(test)
-    dir = "test/services/#{service_name}"
-    empty_directory(dir)
-
-    @test = test.classify
-    path  = "#{dir}/#{test.underscore}_test.rb"
-
-    template 'minitest.rb.erb', path
-  end
-
-  def generate_rspec_test_files(test)
-    dir = "spec/services/#{service_name}"
-    empty_directory(dir)
-
-    @test = test.classify
-    path  = "#{dir}/#{test.underscore}_spec.rb"
-
-    template 'rspec.rb.erb', path
-  end
-
-  def service_name
-    "#{name.underscore}_service"
-  end
 end

data/lib/generators/service/setter/setter_generator.rb

@@ -0,0 +1,32 @@
+require_relative '../setup/setup_generator.rb'
+
+module Service
+  module Generators
+    class SetterGenerator < Rails::Generators::NamedBase
+      check_class_collision
+
+      source_root File.expand_path('templates', __dir__)
+
+      argument :setters, type: :array, default: [], banner: 'setters setters'
+
+      def setup
+        invoke Service::Generators::SetupGenerator, [name]
+      end
+
+      def create_setters
+        setters.each do |s|
+          @setter = s.classify
+
+          path = "app/services/#{service_name}/usecases/setters/#{s.underscore}.rb"
+          template 'setter.rb.erb', path
+        end
+      end
+
+      private
+
+      def service_name
+        "#{name.underscore}_service"
+      end
+    end
+  end
+end

data/lib/generators/service/setter/templates/setter.rb.erb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module <%= service_name.classify %>::Usecases::Setters
+  class <%= @setter %> < CaseBase
+    def call
+      # <payload>
+    end
+
+    def rollback
+    end
+  end
+end

data/lib/generators/service/setup/setup_generator.rb

@@ -0,0 +1,21 @@
+module Service
+  module Generators
+    class SetupGenerator < Rails::Generators::Base
+      def setup
+        return if File.exist?("app/services/#{service_name}")
+
+        empty_directory("app/services/#{service_name}")
+        empty_directory("app/services/#{service_name}/usecases")
+        empty_directory("app/services/#{service_name}/commands")
+        empty_directory("app/services/#{service_name}/usecases/setters")
+        empty_directory("app/services/#{service_name}/usecases/getters")
+      end
+
+      private
+
+      def service_name
+        "#{args.first.underscore}_service"
+      end
+    end
+  end
+end

data/lib/generators/service/test/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate service Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/service/test/test_generator.rb

@@ -0,0 +1,56 @@
+require_relative '../setup/setup_generator.rb'
+
+module Service
+  module Generators
+    class TestGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+      argument :tests, type: :array, default: [], banner: 'usecase usecase'
+
+      def generate_test
+        return if options.skip_test?
+
+        if defined?(Minitest)
+          minitest_test
+        elsif defined?(RSpec)
+          rspec_test
+        end
+      end
+
+      private
+
+      def minitest_test
+        dir = create_test_dir('test')
+
+        tests.each do |t|
+          @test = t.classify
+          path  = "#{dir}/#{t.underscore}_test.rb"
+          template 'minitest.rb.erb', path
+        end
+      end
+
+      def rspec_test
+        dir = create_test_dir('spec')
+
+        tests.each do |t|
+          @test = t.classify
+          path  = "#{dir}/#{t.underscore}_spec.rb"
+          template 'rspec.rb.erb', path
+        end
+      end
+
+      def create_test_dir(path)
+        test_path    = "#{path}/services"
+        service_test = "#{test_path}/#{service_name}"
+
+        empty_directory(test_path)    unless File.exist?(test_path)
+        empty_directory(service_test) unless File.exist?(service_test)
+
+        service_test
+      end
+
+      def service_name
+        "#{name.underscore}_service"
+      end
+    end
+  end
+end

data/lib/generators/service/usecase/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate service Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/service/{templates → usecase/templates}/usecase.rb.erb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 module <%= service_name.classify %>::Usecases
-  class <%= @usecase %> < ServiceBase
+  class <%= @usecase %> < CaseBase
+    include CommandServiceObject::Hooks
     #
     # Your business logic goes here, keep [call] method clean by using private
     # methods for Business logic.
@@ -10,12 +11,12 @@ module <%= service_name.classify %>::Usecases
       replace_me
     end
 
-    private
+    # This method will run if call method raise error
+    def rollback
+      # rollback logic
+    end
 
-      # This method will run if call method raise error
-      def rollback
-        # rollback logic
-      end
+    private
 
       def replace_me
         # [business logic]

data/lib/generators/service/usecase/usecase_generator.rb

@@ -0,0 +1,29 @@
+require_relative '../setup/setup_generator.rb'
+
+module Service
+  module Generators
+    class UsecaseGenerator < Rails::Generators::NamedBase
+      check_class_collision
+
+      source_root File.expand_path('templates', __dir__)
+
+      argument :usecases, type: :array, default: [], banner: 'usecase usecase'
+
+      def call
+        invoke Service::Generators::SetupGenerator, [name]
+
+        usecases.each do |u|
+          @usecase = u.classify
+          path = "app/services/#{service_name}/usecases/#{u.underscore}.rb"
+          template 'usecase.rb.erb', path
+        end
+      end
+
+      private
+
+      def service_name
+        "#{name.underscore}_service"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: command_service_object
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Adham EL-Deeb
+- Mohamed Diaa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-12 00:00:00.000000000 Z
+date: 2019-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +25,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.0.6
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +119,7 @@ description: command_service_object gem helps you to generate service and comman
   objects using rails generator.
 email:
 - adham.eldeeb90@gmail.com
+- mohamed.diaa27@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -111,7 +127,9 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -121,23 +139,45 @@ files:
 - bin/setup
 - command_service_object.gemspec
 - lib/command_service_object.rb
+- lib/command_service_object/configuration.rb
+- lib/command_service_object/failure.rb
+- lib/command_service_object/helpers/controller_helper.rb
+- lib/command_service_object/helpers/failure_helper.rb
+- lib/command_service_object/helpers/model_helper.rb
+- lib/command_service_object/hooks.rb
+- lib/command_service_object/railtie.rb
 - lib/command_service_object/version.rb
 - lib/generators/service/USAGE
+- lib/generators/service/command/USAGE
+- lib/generators/service/command/command_generator.rb
+- lib/generators/service/command/templates/command.rb.erb
+- lib/generators/service/getter/getter_generator.rb
+- lib/generators/service/getter/templates/getter.rb.erb
+- lib/generators/service/install/install_generator.rb
+- lib/generators/service/install/templates/initializer.rb
+- lib/generators/service/install/templates/services/application_service.rb
+- lib/generators/service/install/templates/services/case_base.rb
+- lib/generators/service/install/templates/services/service_result.rb
 - lib/generators/service/service_generator.rb
-- lib/generators/service/templates/base/application_service.rb
-- lib/generators/service/templates/base/service_base.rb
-- lib/generators/service/templates/base/service_controller_helper.rb
-- lib/generators/service/templates/base/service_result.rb
-- lib/generators/service/templates/command.rb.erb
-- lib/generators/service/templates/error.rb.erb
-- lib/generators/service/templates/minitest.rb.erb
-- lib/generators/service/templates/rspec.rb.erb
-- lib/generators/service/templates/usecase.rb.erb
+- lib/generators/service/setter/setter_generator.rb
+- lib/generators/service/setter/templates/setter.rb.erb
+- lib/generators/service/setup/setup_generator.rb
+- lib/generators/service/test/USAGE
+- lib/generators/service/test/templates/minitest.rb.erb
+- lib/generators/service/test/templates/rspec.rb.erb
+- lib/generators/service/test/test_generator.rb
+- lib/generators/service/usecase/USAGE
+- lib/generators/service/usecase/templates/usecase.rb.erb
+- lib/generators/service/usecase/usecase_generator.rb
 homepage: https://github.com/adham90/command_service_object
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/adham90/command_service_object
+  changelog_uri: https://github.com/adham90/command_service_object/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/adham90/command_service_object
+  bug_tracker_uri: https://github.com/adham90/command_service_object/issues
+post_install_message: Yaaay!! CommandServiceObject is ready to rock your app!!
 rdoc_options: []
 require_paths:
 - lib

data/lib/generators/service/templates/base/application_service.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-class ApplicationService < ServiceBase
-  def call
-    ServiceResult.new do
-      cmd.class.name.gsub('Commands', 'Usecases').constantize.call(cmd)
-    end
-  end
-end

data/lib/generators/service/templates/base/service_base.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-class ServiceBase
-  attr_reader :cmd
-
-  def initialize(command)
-    @cmd = command
-  end
-
-  def self.call(command)
-    raise Errors::InvalidCommand, command.class if command.invalid?
-
-    obj = new(command)
-    obj.call
-  rescue StandardError => e
-    error(e)
-    obj.send(:rollback)
-    raise e
-  end
-
-  private
-
-  def self.error(err)
-    # don't log custom errors if you want :D
-    return if err.class.name.start_with?(self.class.name.split('::').first)
-
-    #
-    # Add your logging logic
-    # ex:
-    #   Rollbar.error(err)
-    #
-  end
-
-  def rollback
-    raise NotImplementedError
-  end
-end

data/lib/generators/service/templates/base/service_controller_helper.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module ServiceControllerHelper
-  def self.included(base)
-    base.extend ClassMethods
-  end
-
-  def command(service: nil, usecase: action_name)
-    service_name = service || self.class.default_service || controller_name
-
-    "#{service_name}/commands/#{usecase}".camelize.constantize
-  end
-
-  def execute(cmd)
-    ApplicationService.call(cmd)
-  end
-
-  module ClassMethods
-    @default_service = nil
-
-    def default_service(service_name = nil)
-      @default_service ||= service_name
-    end
-  end
-end

data/lib/generators/service/templates/error.rb.erb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module <%= service_name.classify %>::Errors
-  class <%= @error %> < StandardError
-    def initialize(msg = "custom message")
-      super(msg)
-    end
-  end
-end