service_objects 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06222ac3c2f9261f41273db8c895a31223a3ef29
-  data.tar.gz: 4e4ea02438691b0d12bdd91841caa3d96799bc7e
+  metadata.gz: e743a38993231e20c909e567e8f743b43527ea3f
+  data.tar.gz: 491a38180eccf6a4b8b884d23c6a9d9b84064ab4
 SHA512:
-  metadata.gz: 1d780885f32cee67e8759d31a9dfd9851506bfe6294bac74dade103fba8fa90a56be2749cce93706ecb4a963bbf986950ef40abf6baebb2218a069917b6a7602
-  data.tar.gz: e3356c69b601603fce0b240e4534c568fbe1739eacaca7c658c240829d1740a757f8956e8947bd4e46422220bcd915171d95a2549aac6f6a6518759caa4700f4
+  metadata.gz: fed24fa452deb99ef88a2a8325cc01fea50b91169578b1189c1634a8abcaab984f9d0594caa803feed6fbfb727a59028431b13d8d38791ad0a3d4e1c10154567
+  data.tar.gz: 20c5f8aa9fbca82761bd42df214cb95404c336f16dc3fce588b3d4396c589241b1444b5519d6b82e3280f62c211ab5f49785d7113c8a89a61bc38a4b2a3a83e5

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+*.lock
+.bundle/
+.yardoc/
+coverage/
+doc/
+log/
+pkg/
+tmp/

data/Gemfile

@@ -2,4 +2,4 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "hexx-suit", "~> 2.0", group: :metrics if RUBY_ENGINE == "ruby"
+gem "hexx-suit", "~> 2.0", group: :metrics if RUBY_ENGINE == "ruby"

data/Guardfile

@@ -4,6 +4,8 @@ guard :rspec, cmd: "bundle exec rspec" do
 
   watch("lib/service_objects.rb") { "spec" }
 
+  watch("lib/service_objects/cli/*.*") { "spec/tests/cli_spec.rb" }
+
   watch(%r{^lib/service_objects/(.+)\.rb$}) do |m|
     "spec/tests/#{ m[1] }_spec.rb"
   end

data/README.md

@@ -433,6 +433,20 @@ service.send :add_message type: "excuse", text: :not_informed, subject: "issue"
 # => [<Message text="I haven't been informed on the issue" ...>]
 ```
 
+## Scaffolding
+
+Use CLI command to scaffold a service object with its specification and translations:
+
+```
+service new my_service
+```
+
+To see available options run the command with `-h` option:
+
+```
+service new -h
+```
+
 ## Compatibility
 
 Tested under MRI rubies >= 2.1

data/bin/service

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require "service_objects/cli"
+
+# Scaffolders runner from the command line
+class CLI < Thor
+
+  register(
+    ServiceObjects::CLI,
+    "new",
+    "new NAME[ -d dependency{Default}][ -p option][ -n notification]" \
+    "[ -l en[ ru]][ -f folder]",
+    "Scaffolds a service object with a specification and translations."
+  )
+
+end # class CLI
+
+CLI.start

data/config/metrics/rubocop.yml

@@ -23,9 +23,7 @@ Style/ClassAndModuleChildren:
     - '**/*_spec.rb'
 
 Style/Documentation:
-  Exclude:
-    - '**/version.rb'
-    - '**/*_spec.rb'
+  Enabled: false
 
 Style/EmptyLinesAroundBlockBody:
   Enabled: false

data/lib/service_objects.rb

@@ -1,12 +1,14 @@
 # encoding: utf-8
-require "service_objects/null"
-require "service_objects/utils/normal_hash"
-require "service_objects/listener"
-require "service_objects/message"
-require "service_objects/invalid"
-require "service_objects/base"
 
 # The namespace for the 'service_objects' gem code
 module ServiceObjects
 
+  require_relative "service_objects/version"
+  require_relative "service_objects/null"
+  require_relative "service_objects/utils/normal_hash"
+  require_relative "service_objects/listener"
+  require_relative "service_objects/message"
+  require_relative "service_objects/invalid"
+  require_relative "service_objects/base"
+
 end # module ServiceObjects

data/lib/service_objects/base.rb

@@ -1,15 +1,10 @@
 # encoding: utf-8
 require "wisper"
 
-require "service_objects/helpers/messages"
-require "service_objects/helpers/validations"
-require "service_objects/helpers/exceptions"
-require "service_objects/helpers/dependable"
-require "service_objects/helpers/parameters"
-require "service_objects/helpers/parameterized"
-
 module ServiceObjects
 
+  require_relative "helpers"
+
   # Base class for service objects
   #
   # @example

data/lib/service_objects/cli.rb

@@ -0,0 +1,117 @@
+# encoding: utf-8
+require "hexx-cli"
+
+module ServiceObjects
+
+  require_relative "parsers"
+
+  # Scaffolds a service object with a specification and translations
+  class CLI < Hexx::CLI::Base
+
+    # @private
+    def self.source_root
+      ::File.expand_path "../cli", __FILE__
+    end
+
+    desc "Scaffolds a service object with a specification and translations."
+    namespace :new
+
+    argument(
+      :name,
+      banner: "NAME",
+      desc: "The name of the service",
+      type: :string
+    )
+
+    class_option(
+      :dependencies,
+      aliases: %w(-d),
+      banner: "name{value}",
+      default: %w(),
+      desc: "The list of dependencies for the service object",
+      type: :array
+    )
+
+    class_option(
+      :params,
+      aliases: %w(-p),
+      default: %w(),
+      desc: "The list of service object's parameters",
+      type: :array
+    )
+
+    class_option(
+      :notifications,
+      aliases: %w(-n),
+      default: %w(),
+      desc: "The list of notifications, published by a service",
+      type: :array
+    )
+
+    class_option(
+      :locales,
+      aliases: %w(-l),
+      default: %w(en ru),
+      desc: "The list of locales (languages) for message translations",
+      type: :array
+    )
+
+    class_option(
+      :folder,
+      aliases: %w(-f),
+      default: %w(services),
+      desc: "The folder namespace for the service",
+      type: :array
+    )
+
+    # @private
+    def add_specification
+      template "spec.erb", "spec/tests/#{ service.path }_spec.rb"
+    end
+
+    # @private
+    def add_service
+      template "service.erb", "app/#{ service.path }.rb"
+    end
+
+    # @private
+    def add_locales
+      locales.each do |lang|
+        @locale = lang
+        template "locale.erb", "config/locales/#{ service.path }/#{ lang }.yml"
+      end
+    end
+
+    private
+
+    def service
+      @service ||= Hexx::CLI::Name.new [options[:folder], name].join("/")
+    end
+
+    def project
+      @project ||= Hexx::CLI::Name.new ::File.basename(destination_root)
+    end
+
+    def params
+      @params ||= options[:params].map(&:downcase)
+    end
+
+    def locales
+      @locales ||= options[:locales].map(&:downcase)
+    end
+
+    def notifications
+      @notifications ||=
+        options[:notifications]
+        .map(&Parsers::Notification.method(:new))
+    end
+
+    def dependencies
+      @dependencies ||=
+        options[:dependencies]
+        .map(&Parsers::Dependency.method(:new))
+    end
+
+  end # class CLI
+
+end # module ServiceObjects

data/lib/service_objects/cli/locale.erb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+# Translations for errors and other messages, generated by services of type:
+# <%= service.type %>
+---
+# <%= @locale %>:
+#   activemodel:
+#     errors:
+#       models:
+#         <%= project.path %>/<%= service.path %>:
+#           attributes:
+#             base:
+<% params.sort.each do |item| -%>
+#             <%= item %>:
+<% end -%>
+#     messages:
+#       models:
+#         <%= project.path %>/<%= service.path %>:
+<% notifications.select(&:publish_messages?).each do |item| -%>
+#           <%= item.name %>: @todo
+<% end -%>

data/lib/service_objects/cli/service.erb

@@ -0,0 +1,125 @@
+# encoding: utf-8
+<% tabs = 0 -%>
+<% project.namespaces.each do |item| -%>
+
+<%= "  " * tabs %>module <%= item %>
+<% tabs += 1 -%>
+<% end -%>
+
+<%= "  " * tabs %>module <%= project.const %>
+<% tabs += 1 -%>
+<% service.namespaces.each do |item| -%>
+
+<%= "  " * tabs %>module <%= item %>
+<% tabs += 1 -%>
+<% end -%>
+
+<%= "  " * tabs %># @todo: describe what the service does
+<% if dependencies.any? -%>
+<%= "  " * tabs %>#
+<%= "  " * tabs %># Uses other services:
+<%   dependencies.each do |item| -%>
+<%= "  " * tabs %># * <%= item.name %> (<%= item.type %>)
+<%= "  " * tabs %>#   @todo: describe what is it for
+<%   end -%>
+<% end -%>
+<%= "  " * tabs %>#
+<%= "  " * tabs %># @example
+<%= "  " * tabs %>#   service = <%= service.type %>.new(
+<% params.each do |item| -%>
+<%= "  " * tabs %>#     <%= item %>: @todo,
+<% end -%>
+<%= "  " * tabs %>#   )
+<%= "  " * tabs %>#   service.subscribe listener
+<%= "  " * tabs %>#   service.run
+<%= "  " * tabs %>#
+<%= "  " * tabs %># @param [Hash] params
+<% params.each do |item| -%>
+<%= "  " * tabs %># @option params [@todo] :<%= item %>
+<%= "  " * tabs %>#   @todo: describe the option
+<% end -%>
+<%= "  " * tabs %>#
+<% notifications.each do |item| -%>
+<%= "  " * tabs %># @publish <%= item.name %>(<%= item.args.join(", ") %>)
+<%= "  " * tabs %>#   @todo: describe the condition
+<% end -%>
+<%= "  " * tabs %>class <%= service.const %> < ServiceObjects::Base
+<% dependencies.each do |item| -%>
+
+<%= "  " * tabs %>  # @!attribute <%= item.name %>
+<%= "  " * tabs %>  # @todo: describe the dependency
+<%= "  " * tabs %>  # @return [Class]
+<%= "  " * tabs %>  depends_on <%= item.name %>, default: <%= item.type %>
+<% end -%>
+<% if params.any? -%>
+
+<%= "  " * tabs %>  # Params definition
+<%= "  " * tabs %>  allows_params <%= params.map { |item| ":" << item }.join(", ") %>
+<% end -%>
+<% if notifications.any? -%>
+
+<%= "  " * tabs %>  # Internal exceptions
+<%   notifications.reject(&:error?).to_a[1..-1].to_a.each do |item| -%>
+<%= "  " * tabs %>  <%= item.exception %> = Class.new Invalid
+<%   end -%>
+<% end -%>
+
+<%= "  " * tabs %>  # Runs the service and publishes its results
+<%= "  " * tabs %>  #
+<%= "  " * tabs %>  # @example (see <%= project.type %>::<%= service.type %>)
+<%= "  " * tabs %>  #
+<%= "  " * tabs %>  # @publish (see <%= project.type %>::<%= service.type %>)
+<%= "  " * tabs %>  #
+<%= "  " * tabs %>  # @return  [undefined]
+<%= "  " * tabs %>  def run
+<%= "  " * tabs %>    run!
+<% notifications.reject(&:error?).to_a[1..-1].to_a.each do |item| -%>
+<%= "  " * tabs %>  rescue <%= item.exception %>
+<%= "  " * tabs %>    publish :<%= item.name %>, <%= item.args.join(", ") %>
+<% end -%>
+<%= "  " * tabs %>  rescue Invalid => err
+<%= "  " * tabs %>    publish :error, err.messages
+<%= "  " * tabs %>  else
+<% if (item = notifications.reject(&:error?).first) -%>
+<%= "  " * tabs %>    publish :<%= item.name %>, <%= item.args.join(", ") %>
+<% else -%>
+<%= "  " * tabs %>    # publish :something
+<% end -%>
+<%= "  " * tabs %>  end
+
+<%= "  " * tabs %>  private
+
+<%= "  " * tabs %>  def run!
+<%= "  " * tabs %>  end
+<% notifications.flat_map(&:non_messages).uniq.each do |item| -%>
+
+<%= "  " * tabs %>  def <%= item %>
+<%= "  " * tabs %>  end
+<% end -%>
+<% dependencies.each do |item| -%>
+
+<%= "  " * tabs %>  # The listener of notifications from {#<%= item.name %>}
+<%= "  " * tabs %>  class <%= item.listener %> < ServiceObjects::Listener
+
+<%= "  " * tabs %>    # Callback to be called when no other callback received
+<%= "  " * tabs %>    # @return [undefined]
+<%= "  " * tabs %>    def otherwise
+<%= "  " * tabs %>    end
+
+<%= "  " * tabs %>  end # class <%= item.listener %>
+<% end -%>
+
+<%= "  " * tabs %>end # class <%= service.const %>
+<% service.namespaces.reverse.each do |item| -%>
+
+<% tabs -= 1 -%>
+<%= "  " * tabs -%>end # module <%= item %>
+<% end -%>
+
+<% tabs -= 1 -%>
+<%= "  " * tabs -%>end # module <%= project.const %>
+<% project.namespaces.reverse.each do |item| -%>
+
+<% tabs -= 1 -%>
+<%= "  " * tabs -%>end # module <%= item %>
+<% end -%>

data/lib/service_objects/cli/spec.erb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+require "service_objects/rspec"
+
+describe <%= project.type %>::<%= service.type %> do
+
+  # defines helpers and matcher for testing services:
+  #
+  # Helper arguments:
+  # * params ({} by default)
+  # * service
+  # * listener - it is subscribed for the service
+  #
+  # Helper methods:
+  # * service_double(*args) { |*args| ... }
+  #
+  # Matchers:
+  # * correspond_to(hash)
+  # * be_notified_on(notification, *args)
+  #
+  include ServiceObjects::RSpec
+<% dependencies.each do |item| -%>
+
+  # describe "#<%= item.name %>" do
+
+  #   it "is set to <%= item.type %>" do
+  #     expect(subject.<%= item.name %>).to eq <%= item.type %>
+  #   end
+
+  #   it "is injectable" do
+  #     injection = double
+  #     expect { subject.<%= item.name %> = injection)
+  #       .to change { subject.<%= item.name %> }.to injection
+  #   end
+
+  # end # describe #<%= item.name %>
+<% end -%>
+
+  describe "#run" do
+<% dependencies.each do |item| -%>
+
+    # shared_context "#<%= item.name %> publishes @todo" do |options|
+
+    #   before do
+    #     injection = service_double(@todo) { publish @todo }
+    #     inject :<%= item.name %>, with: options, constucts: injection
+    #   end
+
+    # end # shared_context
+<% end -%>
+<% notifications.each do |item| -%>
+
+    # shared_examples "@todo" do
+
+    #   it "[@todo]" do
+    #     expect { service.run }
+    #       .to change { @todo }
+    #       .from(@todo)
+    #       .to(@todo)
+    #   end
+
+    #   it "publishes :<%= item.name %>" do
+    #     expect(listener)
+    #       .to receive(:<%= item.name %>) do |<%= item.args.join(", ") %>|
+<% item.args.each do |arg| -%>
+    #         expect(<%= arg %>).to eq @todo
+<% end -%>
+    #       end
+    #     service.run
+    #   end
+
+    # end
+<% end -%>
+
+    # context "when @todo" do
+
+    #   before { params.merge! "@todo" => @todo }
+<% dependencies.each do |item| -%>
+    #   include_context "#<%= item.name %> publishes @todo", @todo
+<% end -%>
+    
+    #   it_behaves_like "@todo"
+
+    # end
+
+  end
+
+end # describe <%= project.type %>::<%= service.type %>

data/lib/service_objects/helpers.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module ServiceObjects
+
+  # Contains helper objecs for the base service
+  module Helpers
+
+    require_relative "helpers/messages"
+    require_relative "helpers/validations"
+    require_relative "helpers/exceptions"
+    require_relative "helpers/dependable"
+    require_relative "helpers/parameters"
+    require_relative "helpers/parameterized"
+
+  end # module Helpers
+
+end # module ServiceObjects

data/lib/service_objects/helpers/messages.rb

@@ -3,7 +3,6 @@ require "extlib"
 
 module ServiceObjects
 
-  # Contains helper objecs for the base service
   module Helpers
 
     # Features for collecting service messages

data/lib/service_objects/parsers.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module ServiceObjects
+
+  # Collection of CLI arguments parsers
+  module Parsers
+
+    require_relative "parsers/dependency"
+    require_relative "parsers/notification"
+
+  end # module ServiceObjects
+
+end # module Parsers

data/lib/service_objects/parsers/dependency.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+require "hexx-cli"
+
+module ServiceObjects
+
+  module Parsers
+
+    # Parses and decorates a string, describing a notification
+    #
+    # @example
+    #   result = ServiceObjects::Parsers::Dependency.new "add_item{get_item}"
+    #   result.name     # => add_item
+    #   result.type     # => GetItem
+    #   result.listener # => AddItemListener
+    class Dependency
+
+      # @!scope class
+      # @!method new(source)
+      # Constructs the object from source
+      #
+      # @param  [#to_s] source
+      #
+      # @return [Hexx::Services::Parsers::Dependency]
+      def initialize(source)
+        @source = source.to_s
+      end
+
+      # The name for the dependency default implementation
+      #
+      # @return [String]
+      def name
+        @name ||= injector.item
+      end
+
+      # The type for the dependency default implementation
+      #
+      # @return [String]
+      def type
+        @type ||= injection.type
+      end
+
+      # The listener name for the dependency
+      #
+      # @return [String]
+      def listener
+        @listener ||= "#{ injector.const }Listener"
+      end
+
+      private
+
+      attr_reader :source
+
+      def matcher
+        @matcher ||= source.match(/^(.+){(.+)}$/)
+      end
+
+      def injector
+        @injector ||= Hexx::CLI::Name.new matcher[1]
+      end
+
+      def injection
+        @injection ||= Hexx::CLI::Name.new matcher[2]
+      end
+
+    end # class Dependency
+
+  end # module Parsers
+
+end # module ServiceObjects

data/lib/service_objects/parsers/notification.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+require "extlib"
+
+module ServiceObjects
+
+  module Parsers
+
+    # Parses and decorates a string, describing a notification
+    #
+    # @example
+    #   result = ServiceObjects::Parsers::Notification.new "FOund:iTem:messages"
+    #   result.name               # => found
+    #   result.arguments          # => ["item", "messages"]
+    #   result.non_messages       # => ["item"]
+    #   result.error?             # => false
+    #   result.publish_messages?  # => true
+    class Notification
+
+      # @!scope class
+      # @!method new(source)
+      # Initializes the object from source string
+      #
+      # @param [#to_s] source
+      #
+      # @return [ServiceObjects::Parsers::Notification]
+      def initialize(source)
+        @source = source.to_s
+      end
+
+      # The name for the parsed value
+      # @return [String]
+      def name
+        @name ||= list.first
+      end
+
+      # The type of exception to be raised and catched by service object
+      # @return [String]
+      def exception
+        @exception ||= name.camel_case
+      end
+
+      # The list of published values
+      # @return [Array<String>]
+      def args
+        @args ||= Array(list[1..-1])
+      end
+
+      # The list of pulished values except for messages
+      # @return [Array<String>]
+      def non_messages
+        @non_messages ||= args.reject { |item| item == "messages" }
+      end
+
+      # Checks whether a notification reports an error
+      # @return [Boolean]
+      def error?
+        name == "error"
+      end
+
+      # Checks whether a notification publishes messages
+      # @return [Boolean]
+      def publish_messages?
+        args.include? "messages"
+      end
+
+      # Returns value to order notifications by
+      # @return [0] if a notification is successful
+      # @return [1] if a notification is an error
+      def order
+        @order = error? ? 1 : 0
+      end
+
+      private
+
+      attr_reader :source
+
+      def list
+        @list ||= source.scan(/\w+/).map(&:snake_case)
+      end
+
+    end # module ServiceObjects
+
+  end # module Parsers
+
+end # class Notification

data/lib/service_objects/rspec.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+require "rspec/mocks"
+
+module ServiceObjects
+
+  # Collection of helpers and matchers for testing services
+  #
+  # @example
+  #   require "service_objects/rspec"
+  #   describe MyService do
+  #     include ServiceObjects::RSpec
+  #   end
+  module RSpec
+    include ::RSpec::Mocks::ExampleMethods
+
+    # Params to be given to service object constructor
+    #
+    # @return [Hash]
+    def params
+      @params ||= {}
+    end
+
+    # The service object of described_class, that subscribed the listener
+    #
+    # @return [ServiceObjects::Base]
+    def service
+      @service ||= described_class.new(params).subscribe(listener)
+    end
+
+    # The spy object to listen a service's notifications
+    #
+    # @return [::RSpec::Mocks::Double]
+    def listener
+      spy
+    end
+
+    # Makes given dependency to construct object when called with params
+    #
+    # @example
+    #   before { inject(:get_item, with: { name: :foo }, constructs: foo) }
+    #   service.get_item.new(name: :foo) # => foo
+    #
+    # @return [undefined]
+    def inject(dependency, with: {}, constructs: service_double)
+      klass = Class.new ServiceObjects::Base
+      allow(klass).to receive(:new).with(with).and_return constructs
+      allow(service).to receive(dependency).and_return klass
+    end
+
+    # Mock for another services, the service under test depends from
+    #
+    # The block contains the code to be executed on service #run.
+    #
+    # @example
+    #   let(:another_service) { service_double(:foo) { |name| publish name } }
+    #   another_service.run
+    #   # another_service sends :foo to its listeners
+    #
+    # @param [Array<Object>] args
+    #   the list of arguments for the block
+    # @param [Proc] block
+    #   the block to be yielded by #run method
+    #
+    # @return [ServiceObjects::Base]
+    def service_double(*args, &block)
+      object = ServiceObjects::Base.new
+      allow(object).to receive(:run) do
+        object.instance_exec(*args, &block) if block_given?
+      end
+      object
+    end
+
+  end
+
+end # module ServiceObjects

data/lib/service_objects/version.rb

@@ -4,6 +4,6 @@ module ServiceObjects
 
   # The semantic version of the module.
   # @see http://semver.org/ Semantic versioning 2.0
-  VERSION = "0.0.2".freeze
+  VERSION = "0.1.0".freeze
 
 end # module ServiceObjects

data/service_objects.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |gem|
 
   gem.require_paths    = ["lib"]
   gem.files            = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables      = ["service"]
   gem.test_files       = Dir["spec/**/*.rb"]
   gem.extra_rdoc_files = Dir["README.md", "LICENSE"]
 
@@ -23,6 +24,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "extlib", "~> 0.9"
   gem.add_runtime_dependency "naught", "~> 1.0"
   gem.add_runtime_dependency "wisper", "~> 1.6"
+  gem.add_runtime_dependency "hexx-cli", "~> 0.0"
   gem.add_development_dependency "hexx-rspec", "~> 0.3"
 
 end

data/spec/tests/bin/service_spec.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+describe "$ service new", :sandbox, :capture do
+
+  let(:argv) { %w(foo) }
+
+  before { try_in_sandbox { `service new #{ argv.join(" ") }` } }
+
+  it "runs a scaffolder" do
+    %w(
+      app/services/foo.rb
+      config/locales/services/foo/en.yml
+      config/locales/services/foo/ru.yml
+      spec/tests/services/foo_spec.rb
+    ).each { |file| expect(file).to be_present_in_sandbox }
+  end
+
+end # describe $ service new

data/spec/tests/cli_spec.rb

@@ -0,0 +1,179 @@
+# encoding: utf-8
+require "service_objects/cli"
+
+describe ServiceObjects::CLI, :sandbox, :capture do
+
+  subject { try_in_sandbox { described_class.start options } }
+
+  shared_examples "adding an object" do
+
+    let(:file)    { "app/#{ folder }/foo.rb" }
+    let(:content) { read_in_sandbox(file)    }
+
+    it "[creates file]" do
+      expect(file).to be_present_in_sandbox
+    end
+
+    it "[declares a service]" do
+      expect(content).to include "class Foo < ServiceObjects::Base"
+    end
+
+  end # examples
+
+  shared_examples "adding a specification" do
+
+    it "[creates file]" do
+      expect("spec/tests/#{ folder }/foo_spec.rb").to be_present_in_sandbox
+    end
+
+  end # examples
+
+  shared_examples "adding translations" do |locales|
+
+    it "[creates files]" do
+      locales.each do |locale|
+        file = "config/locales/#{ folder }/foo/#{ locale }.yml"
+        expect(file).to be_present_in_sandbox
+      end
+    end
+
+    it "[adds content]" do
+      locales.each do |locale|
+        file    = "config/locales/#{ folder }/foo/#{ locale }.yml"
+        content = read_in_sandbox(file)
+
+        expect(content).to include("# #{ locale }:")
+        expect(content).to include("#{ folder }/foo:")
+      end
+    end
+
+  end # examples
+
+  shared_examples "using namespaces" do |modules|
+
+    let(:file)    { "app/#{ folder }/foo.rb" }
+    let(:content) { read_in_sandbox(file)    }
+
+    it "[adds modules]" do
+      modules.each do |item|
+        expect(content).to include "module #{ item }"
+      end
+    end
+
+  end # examples
+
+  context "foo" do
+
+    let(:options) { %w(foo)    }
+    let(:folder)  { "services" }
+
+    before { subject }
+
+    it_behaves_like "adding an object"
+    it_behaves_like "using namespaces", %w(Services)
+    it_behaves_like "adding a specification"
+    it_behaves_like "adding translations", %w(en ru)
+
+  end # context
+
+  context "foo -p bar baz" do
+
+    let(:options) { %w(foo -p bar baz) }
+    let(:folder)  { "services" }
+
+    before { subject }
+
+    it_behaves_like "adding an object"
+    it_behaves_like "using namespaces", %w(Services)
+    it_behaves_like "adding a specification"
+    it_behaves_like "adding translations", %w(en ru)
+
+    it "uses parameters" do
+      content = read_in_sandbox("app/services/foo.rb")
+      expect(content).to include "allows_params :bar, :baz"
+    end
+
+  end # context
+
+  context "foo -n foo:bar:baz" do
+
+    let(:options) { %w(foo -n foo:bar:baz cad:cam:messages) }
+    let(:folder)  { "services" }
+
+    before { subject }
+
+    it_behaves_like "adding an object"
+    it_behaves_like "using namespaces", %w(Services)
+    it_behaves_like "adding a specification"
+    it_behaves_like "adding translations", %w(en ru)
+
+    it "uses notifications" do
+      content = read_in_sandbox("app/services/foo.rb")
+      expect(content).to include "publish :foo, bar, baz"
+    end
+
+  end # context
+
+  context "foo -f bar baz" do
+
+    let(:options) { %w(foo -f bar baz) }
+    let(:folder)  { "bar/baz" }
+
+    before { subject }
+
+    it_behaves_like "adding an object"
+    it_behaves_like "using namespaces", %w(Bar Baz)
+    it_behaves_like "adding a specification"
+    it_behaves_like "adding translations", %w(en ru)
+
+  end # context
+
+  context "foo -f bar/baz" do
+
+    let(:options) { %w(foo -f bar/baz) }
+    let(:folder)  { "bar/baz" }
+
+    before { subject }
+
+    it_behaves_like "adding an object"
+    it_behaves_like "using namespaces", %w(Bar Baz)
+    it_behaves_like "adding a specification"
+    it_behaves_like "adding translations", %w(en ru)
+
+  end # context
+
+  context "foo -l jp ua" do
+
+    let(:options) { %w(foo -l jp ua) }
+    let(:folder)  { "services" }
+
+    before { subject }
+
+    it_behaves_like "adding an object"
+    it_behaves_like "using namespaces", %w(Services)
+    it_behaves_like "adding a specification"
+    it_behaves_like "adding translations", %w(jp ua)
+
+  end # context
+
+  context "foo -d get_item{AddItem}" do
+
+    let(:options) { %w(foo -d get_item{AddItem}) }
+    let(:folder)  { "services" }
+
+    before { subject }
+
+    it_behaves_like "adding an object"
+    it_behaves_like "using namespaces", %w(Services)
+    it_behaves_like "adding a specification"
+    it_behaves_like "adding translations", %w(en ru)
+
+    it "uses dependencies" do
+      content = read_in_sandbox("app/services/foo.rb")
+      expect(content).to include "depends_on get_item, default: AddItem"
+      expect(content).to include "GetItemListener"
+    end
+
+  end # context
+
+end # describe

data/spec/tests/parsers/dependency_spec.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+require "service_objects/parsers/dependency"
+
+describe ServiceObjects::Parsers::Dependency do
+
+  subject { described_class.new "Get_item{add/item.do.chain}" }
+
+  describe "#name" do
+
+    it "returns the dependency name in snake case" do
+      expect(subject.name).to eq "get_item"
+    end
+  end
+
+  describe "#type" do
+
+    it "returns the dependency type as is" do
+      expect(subject.type).to eq "Add::Item.do.chain"
+    end
+  end
+
+  describe "#listener" do
+
+    it "returns the dependency listener name" do
+      expect(subject.listener).to eq "GetItemListener"
+    end
+  end
+
+end # describe ServiceObjects::Parsers::Dependency

data/spec/tests/parsers/notification_spec.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+require "service_objects/parsers/notification"
+
+describe ServiceObjects::Parsers::Notification do
+
+  describe "#name" do
+
+    it "returns the name of the notification" do
+      subject = described_class.new "not_found:item:messages"
+      expect(subject.name).to eq "not_found"
+    end
+
+  end # describe #name
+
+  describe "#exception" do
+
+    it "returns the name of the exception" do
+      subject = described_class.new "not_found:item:messages"
+      expect(subject.exception).to eq "NotFound"
+    end
+
+  end # describe #exception
+
+  describe "#args" do
+
+    it "returns all notification arguments" do
+      subject = described_class.new "success:messages:info:item"
+      expect(subject.args).to eq %w(messages info item)
+    end
+
+  end # describe #args" do
+
+  describe "#non_messages" do
+
+    it "returns all args except for messages" do
+      subject = described_class.new "success:messages:info:item"
+      expect(subject.non_messages).to eq %w(info item)
+    end
+
+  end # describe #non_messages
+
+  describe "#publish_messages?" do
+
+    it "returns true if messages published" do
+      subject = described_class.new "found:item:messages"
+      expect(subject.publish_messages?).to eq true
+    end
+
+    it "returns false unless messages published" do
+      subject = described_class.new "found:item:info"
+      expect(subject.publish_messages?).to eq false
+    end
+
+  end # describe #publish_messages?
+
+  describe "#error?" do
+
+    it "returns true for errors" do
+      subject = described_class.new "error:messages"
+      expect(subject).to be_error
+    end
+
+    it "returns false otherwise" do
+      subject = described_class.new "found:messages"
+      expect(subject).not_to be_error
+    end
+
+  end # describe #error?
+
+  describe "#order" do
+
+    it "returns 1 for errors" do
+      subject = described_class.new "error:messages"
+      expect(subject.order).to eq 1
+    end
+
+    it "returns 0 otherwise" do
+      subject = described_class.new "found:messages"
+      expect(subject.order).to eq 0
+    end
+
+  end # describe #order
+
+end # describe ServiceObjects::Parsers::Notification

data/spec/tests/rspec_spec.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+require "service_objects/rspec"
+
+describe ServiceObjects::RSpec do
+
+  let(:test_class) { Class.new(Object).__send__(:include, described_class) }
+  subject { test_class.new }
+
+  describe "#params" do
+
+    it "returns a hash" do
+      expect(subject.params).to eq({})
+    end
+
+  end # describe #params
+
+  describe "listener" do
+
+    it "should be spy" do
+      expect(subject.listener).to be_kind_of ::RSpec::Mocks::Double
+    end
+
+  end # describe #listener
+
+  describe "#service" do
+
+    let(:service_class) { ServiceObjects::Base }
+    before { allow(subject).to receive(:described_class) { service_class } }
+
+    it "returns the object of described class" do
+      expect(subject.service).to be_kind_of(service_class)
+    end
+
+    it "initializes the object with given params" do
+      allow(subject).to receive(:params) { { foo: :bar } }
+
+      expect(service_class)
+        .to receive(:new)
+        .with(subject.params)
+        .and_call_original
+      subject.service
+    end
+
+    it "subscribes the listener" do
+      listener = double
+      allow(subject).to receive(:listener) { listener }
+
+      expect(service_class)
+        .to receive_message_chain(:new, :subscribe)
+        .with(listener)
+      subject.service
+    end
+
+  end # describe #service
+
+  describe "#service_double" do
+
+    it "returns a service object" do
+      expect(subject.service_double).to be_kind_of ServiceObjects::Base
+    end
+
+    it "runs given block in the service's scope" do
+      service_double = subject.service_double(:foo) { |name| publish name }
+      expect(service_double).to receive(:publish).with(:foo)
+      service_double.run
+    end
+
+  end # describe #service_double
+
+  describe "#inject" do
+
+    let(:service_class) { Class.new ServiceObjects::Base }
+    let(:injection)     { double }
+    let(:params)        { double }
+
+    before { allow(subject).to receive(:described_class) { service_class } }
+
+    it "makes service dependency to construct given object" do
+      subject.inject :foo, with: params, constructs: injection
+
+      expect(subject.service.foo.new(params)).to eq injection
+    end
+
+  end # describe #inject
+
+end # describe ServiceObjects::RSpec

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_objects
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-16 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: hexx-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: hexx-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -83,13 +97,15 @@ dependencies:
 description: Base class for objects, that implements both the Interactor and Observer
   design patterns.
 email: andrew.kozin@gmail.com
-executables: []
+executables:
+- service
 extensions: []
 extra_rdoc_files:
 - README.md
 - LICENSE
 files:
 - ".coveralls.yml"
+- ".gitignore"
 - ".metrics"
 - ".rspec"
 - ".rubocop.yml"
@@ -100,6 +116,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/service
 - config/metrics/STYLEGUIDE
 - config/metrics/cane.yml
 - config/metrics/churn.yml
@@ -114,6 +131,11 @@ files:
 - config/metrics/yardstick.yml
 - lib/service_objects.rb
 - lib/service_objects/base.rb
+- lib/service_objects/cli.rb
+- lib/service_objects/cli/locale.erb
+- lib/service_objects/cli/service.erb
+- lib/service_objects/cli/spec.erb
+- lib/service_objects/helpers.rb
 - lib/service_objects/helpers/dependable.rb
 - lib/service_objects/helpers/exceptions.rb
 - lib/service_objects/helpers/messages.rb
@@ -124,11 +146,17 @@ files:
 - lib/service_objects/listener.rb
 - lib/service_objects/message.rb
 - lib/service_objects/null.rb
+- lib/service_objects/parsers.rb
+- lib/service_objects/parsers/dependency.rb
+- lib/service_objects/parsers/notification.rb
+- lib/service_objects/rspec.rb
 - lib/service_objects/utils/normal_hash.rb
 - lib/service_objects/version.rb
 - service_objects.gemspec
 - spec/spec_helper.rb
 - spec/tests/base_spec.rb
+- spec/tests/bin/service_spec.rb
+- spec/tests/cli_spec.rb
 - spec/tests/helpers/dependable_spec.rb
 - spec/tests/helpers/exceptions_spec.rb
 - spec/tests/helpers/messages_spec.rb
@@ -139,6 +167,9 @@ files:
 - spec/tests/listener_spec.rb
 - spec/tests/message_spec.rb
 - spec/tests/null_spec.rb
+- spec/tests/parsers/dependency_spec.rb
+- spec/tests/parsers/notification_spec.rb
+- spec/tests/rspec_spec.rb
 - spec/tests/utils/normal_hash_spec.rb
 homepage: https://github.com/nepalez/service_objects
 licenses:
@@ -168,8 +199,11 @@ test_files:
 - spec/spec_helper.rb
 - spec/tests/listener_spec.rb
 - spec/tests/message_spec.rb
+- spec/tests/cli_spec.rb
 - spec/tests/null_spec.rb
 - spec/tests/base_spec.rb
+- spec/tests/parsers/dependency_spec.rb
+- spec/tests/parsers/notification_spec.rb
 - spec/tests/invalid_spec.rb
 - spec/tests/helpers/parameterized_spec.rb
 - spec/tests/helpers/parameters_spec.rb
@@ -178,4 +212,6 @@ test_files:
 - spec/tests/helpers/exceptions_spec.rb
 - spec/tests/helpers/dependable_spec.rb
 - spec/tests/utils/normal_hash_spec.rb
+- spec/tests/bin/service_spec.rb
+- spec/tests/rspec_spec.rb
 has_rdoc: