command_service_object 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26e3e53d35598d601bf546fc5046c751a0572dd6c936b8e2ded9acfa131699b9
-  data.tar.gz: 93bedb8abb7dd172b52190a51a0978ff963ff812afe5da51f8bb3422d79b8b8c
+  metadata.gz: e7d55b12da58695d99604fb284d14f73a1373a6b637c1de67ec8917b3573b54f
+  data.tar.gz: '09b44ad7cf634686a9e7d6acd73f831428352c0f68fbef97b904eac46ad6a603'
 SHA512:
-  metadata.gz: b5f85e59bd82b841981354719f59fb7e6062887e3dffe42946b18461cfaa5df8e8fcc4d7a223d0436f5a1164be8510dc065aac1c6785b434b4dc3884300a64c5
-  data.tar.gz: 2e368552a3f24ad456a5cbcf3f255a7b7f335765a5ca6c57f162188300cd1fada63aba45396ef648b958ce90eaf898f67ce95f97721ae8a27f41dfd31c6a92e3
+  metadata.gz: ede9b963f6a0bcfe6339e7b4b55b07bab3425e1751c7d6a838a5211e408f8f6c901dea81c11c01deedf799ddce6ce9bc4fe3437be3d320ecf4945f83d8c57edb
+  data.tar.gz: a540e5fc63419308287bc5280d2648bdbcaa3b83ed30c30af9d944e5830c96875c043bc196315bf1da01b20fe2df01574b2d57580baccdab4b4182a42eb08e4c

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+## [v0.4.0](https://github.com/adham90/command_service_object/tree/v0.4.0) (2019-04-12)
+**Closed issues:**
+
+- Generating Specs  [\#1](https://github.com/adham90/command_service_object/issues/1)
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/CONTRIBUTING.md

@@ -0,0 +1,92 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment 
+   variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 
+   do not have permission to do that, you may request the second reviewer to merge it for you.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    command_service_object (0.4.0)
+    command_service_object (0.5.0)
       virtus (~> 1.0.5)
 
 GEM
@@ -54,6 +54,7 @@ GEM
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
     builder (3.2.3)
+    byebug (9.0.6)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
     concurrent-ruby (1.1.5)
@@ -135,6 +136,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
+  byebug (~> 9.0.6)
   command_service_object!
   minitest (~> 5.11, >= 5.11.3)
   rails (~> 5.0)

data/README.md

@@ -25,7 +25,6 @@ Add this line to your application's Gemfile:
 ```ruby
 gem 'command_service_object'
 ```
-
 And then execute:
 
     $ bundle
@@ -34,73 +33,104 @@ Or install it yourself as:
 
     $ gem install command_service_object
 
+Next, you need to run the generator:
+
+```bash
+$ rails generate service:install
+```
+
 ## Usage
 
     $ rails g service [service_name] [usecases usecases]
-### Example
+### Generate Service ex:
 
-    $ rails g service user create update delete
+    $ rails g service auth login
 output
 
 ```bash
-create  app/services/user_service
-create  app/services/user_service/usecases
-create  app/services/user_service/commands
-create  app/services/user_service/errors
-create  app/services/user_service/usecases/create.rb
-create  app/services/user_service/commands/create.rb
-create  app/services/user_service/usecases/update.rb
-create  app/services/user_service/commands/update.rb
-create  app/services/user_service/usecases/delete.rb
-create  app/services/user_service/commands/delete.rb
+app/services/
+├── application_service.rb
+├── auth_service
+│   ├── commands
+│   │   └── login.rb
+│   └── usecases
+│       ├── login.rb
+│       ├── login.rb
+│       ├── getters
+│       └── setters
+│           └── user_profile_image.rb
+├── case_base.rb
+└── service_result.rb
 ```
+
+### Generate setters and getters ex:
+
+    $ rails g service:setter auth user_profile_image
+    $ rails g service:getter auth user_balance
+
 then you can edit command params
 > you can read [Virtus gem docs](https://github.com/solnic/virtus) for more info. 
 ```ruby
-# app/services/user_service/commands/create.rb
-module UserService::Commands
-  class Create
+# app/services/auth_service/commands/login.rb
+# frozen_string_literal: true
+
+module AuthService::Commands
+  class Login
+    # You can read Virtus gem doc for more info.
+    # https://github.com/solnic/virtus
     include Virtus.model
+    include ActiveModel::Validations
 
-    attribute :name, String
-    attribute :phone, String
-    attribute :age, Integer
+    # Attributes
+    # attribute :REPLACE_ME, String
+
+    # Validations
+    # validates :REPLACE_ME, presence: true
   end
 end
 ```
 and then add your business logic
 ```ruby
-# app/services/user_service/usecases/create.rb
-module UserService::Usecases
-  class Create < ServiceBase
+# app/services/auth_service/usecases/login.rb
+# frozen_string_literal: true
+
+module AuthService::Usecases
+  class Login < CaseBase
+    include CommandServiceObject::Hooks
+    setters :user_profile_image
+    getters :user_balance
+    #
+    # Your business logic goes here, keep [call] method clean by using private
+    # methods for Business logic.
+    #
     def call
-        # your business logic goes here
-        # keep call method clean by using private methods for Business logic
-        do_something
-        do_another_something
+      result  = user_profile_image(image_url) # set user profile image ex.
+      balance = user_balance # get user balance ex.
     end
 
-    private
-
-    def do_something
-        # Business logic
-        # Don't catch errors ApplicationService will do that for you
-        raise Errors::CustomeError if ERROR
+    # This method will run if call method raise error
+    def rollback
+      # rollback logic
     end
 
-    def do_another_something
-        # another business logic
-    end
+    private
+
+      def replace_me
+        # [business logic]
+      end
   end
 end
+
 ```
 
 usage from controller
 ```ruby
-class UsersController < ApplicationController
-  def create
-    cmd    = UserService::Commands::Create.new(user_params)
-    result = ApplicationService.call(cmd)
+class AuthenticationController < ApplicationController
+  default_service :auth_service
+
+  def Login
+    cmd    = command.new(params) # AuthService::Commands::Login.new
+    result = execute(cmd)
 
     if result.ok?
       render json: result.value!.as_json, status: 201

data/command_service_object.gemspec

@@ -5,8 +5,8 @@ require 'command_service_object/version'
 Gem::Specification.new do |spec|
   spec.name          = 'command_service_object'
   spec.version       = CommandServiceObject::VERSION
-  spec.authors       = ['Adham EL-Deeb']
-  spec.email         = ['adham.eldeeb90@gmail.com']
+  spec.authors       = ['Adham EL-Deeb', 'Mohamed Diaa']
+  spec.email         = ['adham.eldeeb90@gmail.com', 'mohamed.diaa27@gmail.com']
 
   spec.summary       = 'Rails Generator for command service object.'
   spec.description   = 'command_service_object gem helps you to generate'\
@@ -20,15 +20,24 @@ Gem::Specification.new do |spec|
     end
   end
 
+  spec.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'
+  }
+
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.post_install_message = 'Yaaay!! CommandServiceObject is ready to rock your app!!'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'byebug', '~> 9.0.6'
   spec.add_development_dependency 'minitest', '~> 5.11', '>= 5.11.3'
   spec.add_development_dependency 'rails', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'thor', '~> 0.20.3'
 
-  spec.add_runtime_dependency 'virtus', '~> 1.0.5'
+  spec.add_dependency 'virtus', '~> 1.0.5'
 end

data/lib/command_service_object/configuration.rb

@@ -0,0 +1,14 @@
+module CommandServiceObject
+  class Configuration
+    attr_accessor :append_controller_helper, :command_method_name
+    attr_accessor :skip_command, :skip_test, :skip_error
+
+    def initialize
+      @append_controller_helper = true
+      @command_method_name = :command
+      @skip_command = false
+      @skip_test = false
+      @skip_error = true
+    end
+  end
+end

data/lib/command_service_object/failure.rb

@@ -0,0 +1,10 @@
+module CommandServiceObject
+  class Failure < StandardError
+    attr_reader :extra_data
+
+    def initialize(message: nil, extra_data: {})
+      @extra_data = extra_data
+      super(message)
+    end
+  end
+end

data/lib/command_service_object/helpers/controller_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module CommandServiceObject
+  module ControllerHelper
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    ActiveSupport.on_load :action_controller do
+      define_method(CommandServiceObject.configuration.command_method_name) \
+        do |service: nil, usecase: action_name|
+        service_name = service || self.class.default_service || controller_name
+
+        "#{service_name}/commands/#{usecase}".camelize.constantize
+      end
+    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
+end

data/lib/command_service_object/helpers/failure_helper.rb

@@ -0,0 +1,7 @@
+module CommandServiceObject
+  module FailureHelper
+    def fail!(message: '', extra_data: {})
+      raise Failure, message: message, extra_data: extra_data
+    end
+  end
+end

data/lib/command_service_object/helpers/model_helper.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module CommandServiceObject
+  module ModelHelper
+    def model_name
+      name.camelize
+    end
+
+    def model_class
+      Object.const_get(model_name)
+    rescue StandardError
+      nil
+    end
+
+    def model_attributes
+      return { REPLACE_ME: String } if model_class.nil?
+
+      attrs = {}
+      model_class.columns_hash.each do |k, v|
+        next if ignored_column_names.include?(k)
+
+        type = allowed_column_types[v.type]
+        next if type.nil?
+
+        attrs[k] = type
+      end
+      attrs
+    end
+
+    def ignored_column_names
+      %w[
+        created_at
+        updated_at
+        encrypted_password
+      ]
+    end
+
+    def allowed_column_types
+      {
+        string: 'String',
+        bigint: 'Integer',
+        integer: 'Integer',
+        decimal: 'Float',
+        boolean: 'Boolean',
+        datetime: 'DateTime'
+      }
+    end
+  end
+end

data/lib/command_service_object/hooks.rb

@@ -0,0 +1,87 @@
+module CommandServiceObject
+  module Hooks
+    def self.included(base)
+      base.send :extend, ClassMethods
+      base.send :include, InstanceMethods
+
+      class << base
+        alias_method :_new, :new
+
+        define_method :new do |command|
+          _new(command).tap do |instance|
+            instance.send(:setup_setters, _setters)
+            instance.send(:setup_getters, _getters)
+          end
+        end
+      end
+    end
+
+    module InstanceMethods
+      attr_accessor :_called_setters
+
+      def _called_setters
+        @_called_setters ||= []
+      end
+
+      def rollback_setters
+        _called_setters.reverse_each(&:rollback)
+      end
+
+      def setup_getters(getters)
+        getters.each do |getter|
+          method_name = getter.name.split('::').last.underscore
+
+          define_singleton_method(method_name) do |payload|
+            getter.new.call(args)
+          end
+        end
+      end
+
+      def setup_setters(setters)
+        setters.each do |setter|
+          method_name = setter.name.split('::').last.underscore
+
+          # unrollable setters
+          define_singleton_method("#{method_name}!") do |payload|
+            setter.new(payload).call
+          end
+
+          # rollable setters
+          define_singleton_method(method_name) do |payload|
+            obj = setter.new(payload)
+            obj.call
+
+            _called_setters << obj
+            obj
+          end
+        end
+      end
+    end
+
+    module ClassMethods
+      cattr_accessor :_getters, :_setters
+
+      def _setters
+        @_setters ||= Set.new([])
+      end
+
+      def _getters
+        @_getters ||= Set.new([])
+      end
+
+      def setters(name)
+        service = to_s.split('::').first
+        obj     = "#{service}/Usecases/Setters/#{name}".camelize.constantize
+
+        _setters.add(obj)
+      end
+
+      def getters(name)
+        service = to_s.split('::').first
+        obj     = "#{service}/Usecases/Getters/#{name}".camelize.constantize
+
+        _getters.add(obj)
+      end
+    end
+  end
+end

data/lib/command_service_object/railtie.rb

@@ -0,0 +1,13 @@
+module CommandServiceObject
+  class Railtie < Rails::Railtie
+    initializer 'configure_rails_initialization' do |_app|
+      ActiveSupport.on_load :action_controller do
+        CommandServiceObject::Railtie.setup_action_controller
+      end
+    end
+
+    def self.setup_action_controller
+      ActionController::Base.send :include, ControllerHelper
+    end
+  end
+end

data/lib/command_service_object/version.rb

@@ -1,3 +1,3 @@
 module CommandServiceObject
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/lib/command_service_object.rb

@@ -1,6 +1,29 @@
 require 'command_service_object/version'
+require 'command_service_object/configuration'
+require 'command_service_object/failure'
+require 'command_service_object/helpers/model_helper'
+require 'command_service_object/helpers/controller_helper'
+require 'command_service_object/helpers/failure_helper'
+require 'command_service_object/hooks'
+
+if defined?(Rails) && Rails::VERSION::STRING >= '3.0'
+  require 'command_service_object/railtie'
+end
 
 module CommandServiceObject
-  class Error < StandardError; end
-  # Your code goes here...
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
 end

data/lib/generators/service/command/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/command/command_generator.rb

@@ -0,0 +1,29 @@
+require_relative '../setup/setup_generator.rb'
+
+module Service
+  module Generators
+    class CommandGenerator < Rails::Generators::NamedBase
+      include CommandServiceObject::ModelHelper
+
+      source_root File.expand_path('templates', __dir__)
+
+      argument :commands, type: :array, default: [], banner: 'command command'
+
+      def call
+        invoke Service::Generators::SetupGenerator, [name]
+        @model_attributes = model_attributes
+        commands.each do |c|
+          @command = c.classify
+          path = "app/services/#{service_name}/commands/#{c.underscore}.rb"
+          template 'command.rb.erb', path unless options.skip_command?
+        end
+      end
+
+      private
+
+      def service_name
+        "#{name.underscore}_service"
+      end
+    end
+  end
+end

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

@@ -5,7 +5,14 @@ module <%= service_name.classify %>::Commands
     # You can read Virtus gem doc for more info.
     # https://github.com/solnic/virtus
     include Virtus.model
+    include ActiveModel::Validations
 
-    attribute :REPLACE_ME, String
+    # Attributes
+    <%- @model_attributes.each do |k,v| -%>
+    # attribute :<%=k%>, <%=v%>
+    <%- end -%>
+
+    # Validations
+    # validates :REPLACE_ME, presence: true
   end
 end

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

@@ -0,0 +1,32 @@
+require_relative '../setup/setup_generator.rb'
+
+module Service
+  module Generators
+    class GetterGenerator < Rails::Generators::NamedBase
+      check_class_collision
+
+      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