command_service_object 0.6.4 → 1.2.1

data/lib/generators/service/service_generator.rb

@@ -4,9 +4,9 @@ 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'
+require_relative './helper.rb'
 
 module Service
   module Generators
@@ -16,6 +16,7 @@ module Service
       # 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_entity,  type: :boolean, default: false, aliases: '-E'
       class_option :skip_test,    type: :boolean, default: false, aliases: '-T'
 
       def install_if_not
@@ -40,10 +41,18 @@ module Service
         invoke Service::Generators::CommandGenerator, [name, usecases]
       end
 
-      def generate_tests
-        return if options.skip_test?
+      private
 
-        invoke Service::Generators::TestGenerator, [name, usecases]
+      def service_name
+        Service::Helper.service_name(name)
+      end
+
+      def service_path
+        Service::Helper.service_path(name)
+      end
+
+      def spec_path
+        Service::Helper.spec_path(name)
       end
     end
   end

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

@@ -1,19 +1,33 @@
+require_relative '../helper'
+
 module Service
   module Generators
     class SetupGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      DIRS = %w(listeners jobs externals queries usecases commands entities usecases/micros)
+
       def setup
-        return if File.exist?("app/services/#{service_name}")
+        DIRS.each do |dir|
+          empty_directory("#{service_path}/#{dir}")
+        end
 
-        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/micros")
+        path = "#{service_path}/doc.md"
+        template 'doc.md.erb', path unless File.exist?(path)
       end
 
       private
 
       def service_name
-        "#{args.first.underscore}_service"
+        Service::Helper.service_name(args.first)
+      end
+
+      def service_path
+        Service::Helper.service_path(args.first)
+      end
+
+      def spec_path
+        Service::Helper.spec_path(args.first)
       end
     end
   end

data/lib/generators/service/setup/templates/doc.md.erb

@@ -0,0 +1,39 @@
+## <%= service_name.classify %>
+The authorization system is responsible for identifying a particular user.
+
+### Database Tables
+- users
+- profiles
+
+### Entities:
+###### *Many objects are not fundamentally defined by their attributes, but rather by a thread of continuity and identity.*
+- User
+  - name: string
+  - email: string
+  - phone: string
+  - Profile:
+    - address: string
+    - foo: boolean
+    - bar: int
+
+### Usecases (Processes):
+###### *Use Cases focus on Users, Actions, and Processes.*
+- **[Login](login-uml-and-full-doc)** - the process for authorization, we write out to the user an authentication key for a month. Only a user with a verified phone and email address can authenticate.
+- **[Logout](logout-uml-and-full-doc)** - After logging out, the user will need to log in again to access the system.
+
+### Queries:
+- FindByEmail(email: string)
+- FindByName(name: string)
+
+### Listeners:
+###### *An event listener that waits for an event outside the service to occur.*
+- order_status
+
+### Externals:
+###### *Wrapper for any external interactions.*
+- **UserService**
+  - user_info(id: id)
+- **Stripe** - payment gateway wrapper.
+  - charge(pid, amount, currency)
+  - refund(charge_id)
+  - create_customer(email, phone, name)

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

@@ -7,7 +7,17 @@ module <%= service_name.classify %>::Usecases
     # methods for Business logic.
     #
     def call
+      # Use check! for business logic validation,
+      # If the given block returns false then it will raise a business logic failure with the given message.
+      # Ex: check!("user should not have any active cards") { cmd.issuer.active_cards.empty? }
+
       replace_me
+
+      output
+    end
+
+    def output
+      # return entity object
     end
 
     # This method will run if call method raise error
@@ -24,10 +34,14 @@ module <%= service_name.classify %>::Usecases
       true
     end
 
+    def broadcast
+      Hutch.publish('<%= service_name %>', action: '<%= "#{@usecase.underscore}" %>', subject: {})
+    end
+
     private
 
-      def replace_me
-        # [business logic]
-      end
+    def replace_me
+      # [business logic]
+    end
   end
 end

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

@@ -1,4 +1,5 @@
 require_relative '../setup/setup_generator.rb'
+require_relative '../helper'
 
 module Service
   module Generators
@@ -12,15 +13,33 @@ module Service
 
         usecases.each do |u|
           @usecase = u.classify
-          path = "app/services/#{service_name}/usecases/#{u.underscore}.rb"
-          template 'usecase.rb.erb', path
+          create_main(u)
+          create_test(u)
         end
       end
 
       private
 
+      def create_main(m)
+        path = "#{service_path}/usecases/#{m.underscore}.rb"
+        template 'usecase.rb.erb', path unless options.skip_command?
+      end
+
+      def create_test(m)
+        path = "#{spec_path}/usecases/#{m.underscore}_spec.rb"
+        template 'usecase_spec.rb.erb', path
+      end
+
       def service_name
-        "#{name.underscore}_service"
+        Service::Helper.service_name(name)
+      end
+
+      def service_path
+        Service::Helper.service_path(name)
+      end
+
+      def spec_path
+        Service::Helper.spec_path(name)
       end
     end
   end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: command_service_object
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 1.2.1
 platform: ruby
 authors:
 - Adham EL-Deeb
 - Mohamed Diaa
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-06 00:00:00.000000000 Z
+date: 2020-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,14 +79,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -121,6 +121,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: hutch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: command_service_object gem helps you to generate service and command
   objects using rails generator.
 email:
@@ -148,36 +162,47 @@ files:
 - lib/command_service_object.rb
 - lib/command_service_object/configuration.rb
 - lib/command_service_object/failure.rb
+- lib/command_service_object/helpers/check_helper.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/.DS_Store
 - 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/command/templates/command_spec.rb.erb
+- lib/generators/service/entity/entity_generator.rb
+- lib/generators/service/entity/templates/entity.rb.erb
+- lib/generators/service/external/external_generator.rb
+- lib/generators/service/external/templates/external.rb.erb
+- lib/generators/service/external/templates/external_spec.rb.erb
+- lib/generators/service/external/templates/external_test.rb.erb
+- lib/generators/service/helper.rb
 - 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/command_base.rb
+- lib/generators/service/install/templates/services/listener_base.rb
+- lib/generators/service/install/templates/services/query_base.rb
 - lib/generators/service/install/templates/services/service_result.rb
+- lib/generators/service/listener/listener_generator.rb
+- lib/generators/service/listener/templates/listener.rb.erb
 - lib/generators/service/micro/micro_generator.rb
 - lib/generators/service/micro/templates/micro.rb.erb
-- lib/generators/service/policies.rb
+- lib/generators/service/query/USAGE
+- lib/generators/service/query/query_generator.rb
+- lib/generators/service/query/templates/query.rb.erb
 - lib/generators/service/service_generator.rb
 - lib/generators/service/setup/setup_generator.rb
-- lib/generators/service/test/USAGE
-- lib/generators/service/test/templates/minitest/usecase.rb.erb
-- lib/generators/service/test/templates/rspec/command.rb.erb
-- lib/generators/service/test/templates/rspec/usecase.rb.erb
-- lib/generators/service/test/test_generator.rb
+- lib/generators/service/setup/templates/doc.md.erb
 - lib/generators/service/usecase/USAGE
 - lib/generators/service/usecase/templates/usecase.rb.erb
+- lib/generators/service/usecase/templates/usecase_spec.rb.erb
 - lib/generators/service/usecase/usecase_generator.rb
 homepage: https://github.com/adham90/command_service_object
 licenses:
@@ -202,8 +227,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Rails Generator for command service object.
 test_files: []

data/lib/generators/service/getter/getter_generator.rb

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

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

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

data/lib/generators/service/policies.rb

@@ -1,5 +0,0 @@
-class
-  def initialize(*args)
-
-  end
-end

data/lib/generators/service/test/USAGE

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

data/lib/generators/service/test/templates/minitest/usecase.rb.erb

@@ -1 +0,0 @@
-# frozen_string_literal: true

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

@@ -1,72 +0,0 @@
-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}/usecases/#{t.underscore}_test.rb"
-          template 'minitest/usecase.rb.erb', path
-        end
-      end
-
-      def rspec_test
-        dir = create_test_dir('spec')
-        create_usecase_test(dir)
-        create_command_test(dir)
-      end
-
-      def create_usecase_test(dir)
-        tests.each do |t|
-          @test = t.classify
-          path  = "#{dir}/usecases/#{t.underscore}_spec.rb"
-          template 'rspec/usecase.rb.erb', path
-        end
-      end
-
-      def create_command_test(dir)
-        tests.each do |t|
-          @test = t.classify
-          path  = "#{dir}/commands/#{t.underscore}_spec.rb"
-          template 'rspec/command.rb.erb', path
-        end
-      end
-
-      def create_test_dir(path)
-        test_path    = "#{path}/services"
-        service_test = "#{test_path}/#{service_name}"
-        usecases_path = "#{test_path}/#{service_name}/usecases"
-        commands_path = "#{test_path}/#{service_name}/commands"
-
-        empty_directory(test_path)    unless File.exist?(test_path)
-        empty_directory(service_test) unless File.exist?(service_test)
-        empty_directory(usecases_path) unless File.exist?(usecases_path)
-        empty_directory(commands_path) unless File.exist?(commands_path)
-
-        service_test
-      end
-
-      def service_name
-        "#{name.underscore}_service"
-      end
-    end
-  end
-end