caze 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fa3f1d633d3f5be1fef1c11ea978737c81cc9df
-  data.tar.gz: 6604b18e4f354bdf51f46ed63e3f06b26cc27c38
+  metadata.gz: 99a71bded9755881944f839759a8d2c9d8aa521f
+  data.tar.gz: 57c4a32446ab668e9c1f3939010c8695abf279f1
 SHA512:
-  metadata.gz: e47427f4198ca41f680b97dc3243b8c64ef04f3c76b9747bc888db83fda45eec6839440990b9e9586de267b6a29fb9ae73bf09aa98faed0ac0554b1895db82fc
-  data.tar.gz: 14e9aba9004594e10ef9c8a73e66c60ffbbac50506172a7cbb73ca85cfc4fce91ec2e66126e3553ad189c7caffb452b24eeca43cf944ccf53d0b2f1070458cfa
+  metadata.gz: 32950a65706b076730f5dd61dcf0280fe0dc8425ca154e50e9e1213c8a726f7937adec28ebea7bd1d369eb74a0b7ae4190756dc37d39ff50991e0fc0daf47ee6
+  data.tar.gz: 372c8062bda691df0d8ae6fff1cc89508fcbc0ddcacdca31c15973d6c05c4faff26f2328a8a7586b0e5655e4655593d5e2781fda056432b069b07ca6d5d05d9d

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.2

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Change log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.1.0] - 2015-10-20
+
+### Added
+
+- Add support to define use cases as string.
+- Add CHANGELOG.md following the [Keep a changelog](http://keepachangelog.com/).
+
+## [0.0.4] - 2015-04-10
+
+### Fixed
+
+- Fix the transactional method dispatch.
+
+## [0.0.3] - 2015-02-05
+
+### Changed
+
+- Change main methods to define use cases and export them.
+- Add more details about the API and how to use the lib at README.
+
+[unreleased]: https://github.com/magnetis/caze/compare/v0.0.4...HEAD
+[0.0.4]: https://github.com/magnetis/caze/compare/v0.0.3...v0.0.4
+[0.0.3]: https://github.com/magnetis/caze/compare/v0.0.2...v0.0.3

data/README.md

@@ -1,5 +1,9 @@
 # Caze
 
+[![Build status](https://img.shields.io/travis/magnetis/caze.svg)](https://travis-ci.org/magnetis/caze)
+[![Gem version](https://img.shields.io/gem/v/caze.svg)](https://rubygems.org/gems/caze)
+[![Downloads](https://img.shields.io/gem/dt/caze.svg)](https://rubygems.org/gems/caze)
+
 This is a simple DSL to declare use cases as entry points of a module.
 The purpose is to avoid the verbose declarations.
 
@@ -10,11 +14,11 @@ Instead of doing this:
 ```ruby
 module Project
   def self.sum(x, y)
-    UseCases::Sum.execute(x, y)
+    UseCases::Sum.sum(x, y)
   end
 
   def self.subtract(x, y)
-    UseCases::Subtract.execute(x, y)
+    UseCases::Subtract.subtract(x, y)
   end
 end
 ```
@@ -27,8 +31,8 @@ require 'caze'
 module Project
   include Caze
 
-  has_use_case sum:      UseCases::Sum,
-  has_use_case subtract: UseCases::Subtract
+  has_use_case :sum, UseCases::Sum
+  has_use_case :subtract, UseCases::Subtract
 end
 ```
 
@@ -46,7 +50,7 @@ While declaring which use cases your app has, you can set the option
 `transactional` to `true`.
 
 ```ruby
-  has_use_case wow: UseCases::Wow, transactional: true
+has_use_case :wow, UseCases::Wow, transactional: true
 ```
 
 Note that the transaction handler must implement `#transaction` and
@@ -61,8 +65,8 @@ Inside the use case classes you can use the `.export` method, so in the `UseCase
 module Project
   module UseCases
     class Sum
-      def self.execute(x ,y)
-        new(x,y).foo
+      def self.sum(x ,y)
+        new(x,y).sum
       end
 
       def initialize(x, y)
@@ -102,8 +106,7 @@ end
 ```
 
 The `as` param, tells how the class method must be named,
-if it is not passed the class method will have the of the instance method.
-
+if it is not passed the class method will have the same name of the instance method.
 
 With this you can call your project use cases without the need to know its internals:
 
@@ -111,6 +114,16 @@ With this you can call your project use cases without the need to know its inter
 Project.sum(4, 2) # This will call sum inside the use case `UseCases::Sum`
 ```
 
+# Installation
+
+Add to your Gemfile:
+
+```
+gem 'caze', '~> 0.4.0'
+```
+
+Run `bundle install`.
+
 # Apache License 2.0
 
 Check LICENSE.txt

data/Rakefile

@@ -1,2 +1,9 @@
 require "bundler/gem_tasks"
 
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+end

data/caze.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

data/lib/caze.rb

@@ -11,19 +11,24 @@ module Caze
     attr_accessor :transaction_handler
 
     def has_use_case(use_case_name, use_case_class, options = {})
-      transactional  = options.fetch(:transactional) { false }
+      transactional = options.fetch(:transactional) { false }
+
+      define_singleton_method(use_case_name, Proc.new do |*args|
+        use_case = get_use_case_class(use_case_class)
 
-      define_singleton_method(use_case_name, Proc.new { |*args|
         if transactional
           handler = self.transaction_handler
 
-          raise NoTransactionMethodError, "This action should be executed inside a transaction. But no transaction handler was configured." unless handler
+          unless handler
+            raise NoTransactionMethodError,
+              "This action should be executed inside a transaction. But no transaction handler was configured."
+          end
 
-          handler.transaction { use_case_class.send(use_case_name, *args) }
+          handler.transaction { use_case.send(use_case_name, *args) }
         else
-          use_case_class.send(use_case_name, *args)
+          use_case.send(use_case_name, *args)
         end
-      })
+      end)
     end
 
     def export(method_name, options = {})
@@ -34,5 +39,15 @@ module Caze
         use_case_object.send(method_name)
       })
     end
+
+    private
+
+    def get_use_case_class(use_case_class)
+      if use_case_class.respond_to?(:upcase)
+        return Object.const_get(use_case_class)
+      end
+
+      use_case_class
+    end
   end
 end

data/lib/caze/version.rb

@@ -1,3 +1,3 @@
 module Caze
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/spec/caze_spec.rb

@@ -14,6 +14,8 @@ describe Caze do
 
       export :the_answer
       export :the_answer, as: :the_transactional_answer
+      export :the_answer, as: :the_answer_by_another_entry_point
+      export :the_answer, as: :the_universal_answer
 
       def the_answer
         42
@@ -38,6 +40,8 @@ describe Caze do
       include Caze
 
       has_use_case :the_answer, DummyUseCase
+      has_use_case :the_answer_by_another_entry_point, 'DummyUseCase'
+      has_use_case :the_universal_answer, :DummyUseCase
       has_use_case :the_answer_for, DummyUseCaseWithParam
       has_use_case :the_transactional_answer, DummyUseCase, transactional: true
     end
@@ -47,8 +51,9 @@ describe Caze do
   let(:app) { Dummy }
 
   describe '.has_use_case' do
-    it 'delegates the use case message to the use case' do
-      allow(use_case).to receive(:the_answer)
+    it 'delegates the message to the use case' do
+      expect(use_case).to receive(:the_answer)
+
       app.the_answer
     end
 
@@ -58,6 +63,22 @@ describe Caze do
       end
     end
 
+    context 'when use case class is declared as string' do
+      it 'delegates the message to the use case' do
+        expect(use_case).to receive(:the_answer_by_another_entry_point)
+
+        app.the_answer_by_another_entry_point
+      end
+    end
+
+    context 'when use case class is declared as symbol' do
+      it 'delegates the message to the use case' do
+        expect(use_case).to receive(:the_universal_answer)
+
+        app.the_universal_answer
+      end
+    end
+
     context 'using transaction' do
       context 'when there is a transaction method' do
         let(:transaction_handler) { double(:transaction_handler) }
@@ -68,6 +89,7 @@ describe Caze do
 
         it 'uses the transaction handler' do
           expect(transaction_handler).to receive(:transaction).and_yield
+
           app.the_transactional_answer
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caze
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Philip Sampaio
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-10 00:00:00.000000000 Z
+date: 2015-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,6 +90,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -111,7 +113,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -119,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A DSL to define use cases