neco 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b8600b54de50cbf86de418e8ac297f91ca7944829ad55a970c212f7ebe9f3bc
-  data.tar.gz: 0b96f25e550ce59eff7822f73173da69198c6c6ad2db83fa7b8f0b5c30b9e224
+  metadata.gz: '09593673a33bf626933d34caa3e67de31d0b38bbbec9d5d5e8859208453879c3'
+  data.tar.gz: a946ab87bdb749357ad6a9d22b45caa3de04d4914feede5f74bdbaedc0d68a8c
 SHA512:
-  metadata.gz: '05398284cdd89b706c5c37134fabf33ee97475396555c8a49f264e0595efec4ba80d4ee69b2cc980b107e340e69467d13154cec84e1faffe167e96d5f0ccc9ea'
-  data.tar.gz: d0a0fe2de63bcb45e152a94112ef5470610bc9e4e18d3a8616bfc0617388e08598e0452e65caa56e5cee9e574206b643fd8143be5f96939c800f8cbbaf00ae42
+  metadata.gz: ffc374588f707eb08f6d5a0bd1703c17f13c49e60b956de7032c09491e659db82a9a11795b23f213cb579aa87f38a6279d4f70e750dcab9f48ace4dfda3fbf37
+  data.tar.gz: 7cc86cb61a48a396b1ec8f724952d99b486e22e2d62227d57af57dc57f2421b14e7f6c4cf843da62273c277d98bb7924f402ad909a1f6997b8134484d14fc458

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    neco (0.1.0)
+    neco (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -18,15 +18,15 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     rainbow (3.0.0)
-    rake (10.5.0)
-    rubocop (0.70.0)
+    rake (12.3.2)
+    rubocop (0.71.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.0)
+    ruby-progressbar (1.10.1)
     unicode-display_width (1.6.0)
 
 PLATFORMS
@@ -37,7 +37,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   neco!
   pry (>= 0.12.2)
-  rake (~> 10.0)
+  rake (~> 12.3)
   rubocop (>= 0.70.0)
 
 BUNDLED WITH

data/README.md

@@ -1,8 +1,9 @@
-# Neco
+[![Build Status](https://travis-ci.com/okuramasafumi/neco.svg?branch=master)](https://travis-ci.com/okuramasafumi/neco)
+[![Maintainability](https://api.codeclimate.com/v1/badges/d011a37ef8ebf1ea2afd/maintainability)](https://codeclimate.com/github/okuramasafumi/neco/maintainability)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/neco`. To experiment with that code, run `bin/console` for an interactive prompt.
+# Neco
 
-TODO: Delete this and the text above, and describe your gem
+Neco is a NEo COmmand pattern library for Ruby.
 
 ## Installation
 
@@ -22,7 +23,75 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Include `Neco::Command` module and define your command with DSLs like below:
+
+```ruby
+class Foo
+  include Neco::Command
+
+  validates do |name:|
+    name == 'Tama'
+  end
+
+  main do |name:|
+    puts "Hello, #{name}!"
+  end
+end
+
+Foo.call(name: 'Tama') # => 'Hello, Tama!'
+```
+
+Here, `validates` block defines validations and `main` block defines main logic for the command (simple, right?)
+
+You can also compose multiple commands into one command using `Neco::Composition` module. Neco automatically triggers rollbacks when one of the commands raises an exception.
+
+```ruby
+class Command1
+  include Neco::Command
+
+  main do
+    set :cat_name, 'Tama'
+  end
+
+  rollback do
+    puts 'Rolling back Command1!'
+  end
+end
+
+class Command2
+  include Neco::Command
+
+  main do |cat_name:|
+    puts "Hello, #{cat_name}!"
+  end
+
+  rollback do
+    puts 'Rolling back Command2!'
+  end
+end
+
+class Command3
+  include Neco::Command
+
+  # Unused block argument
+  main do |cat_name:|
+    raise 'OMG!!!'
+  end
+end
+
+class Bar
+  include Neco::Composition
+
+  composes Command1, Command2, Command3
+end
+
+Bar.call
+# => 'Hello, Tama!'
+# => 'Rolling back Command2!'
+# => 'Rolling back Command1!'
+```
+
+See `examples` directory for details.
 
 ## Development
 
@@ -32,7 +101,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/neco. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/okuramasafumi/neco. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +109,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Neco project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/neco/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Neco project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/okuramasafumi/neco/blob/master/CODE_OF_CONDUCT.md).

data/lib/neco/command.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'neco/container'
+require 'neco/result'
 
 module Neco
   # Command module is a basic module of Neco.
@@ -31,7 +32,6 @@ module Neco
       def call(*args, **params)
         instance = new(*args, **params)
         instance.call
-        true
       end
     end
 
@@ -55,7 +55,12 @@ module Neco
         return false unless validate
 
         main = self.class.instance_variable_get(:@main)
-        instance_exec(*@args, **@params, &main)
+        begin
+          instance_exec(*@args, **@params, &main)
+          Success.new
+        rescue StandardError => e
+          Failure.new(exception: e)
+        end
       end
 
       def validate

data/lib/neco/container.rb

@@ -14,11 +14,13 @@ module Neco
     def call(*args, **params)
       @environment.merge!(params)
       @commands.each do |command|
-        command.call(*args, **@environment)
-        @called << command
-      rescue StandardError
-        @called.reverse_each(&:revert)
-        break
+        result = command.call(*args, **@environment)
+        if result.success?
+          @called << command
+        else
+          @called.reverse_each(&:revert)
+          break
+        end
       end
     end
 

data/lib/neco/result.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Neco
+  # Base class of Result
+  class Result
+  end
+
+  # Success is returned when the command executed successfully.
+  class Success < Result
+    def success?
+      true
+    end
+
+    def failure?
+      false
+    end
+  end
+
+  # Failure is returned when the command failed.
+  # This class has several extra information because failure has many ways to achieve
+  # while success has only one way.
+  class Failure < Result
+    def initialize(exception:)
+      @exception = exception
+    end
+
+    def success?
+      false
+    end
+
+    def failure?
+      true
+    end
+
+    def message
+      @exception.message
+    end
+  end
+end

data/lib/neco/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Neco
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/neco.gemspec

@@ -30,6 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'pry', '>= 0.12.2'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rubocop', '>= 0.70.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neco
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-24 00:00:00.000000000 Z
+date: 2019-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +106,7 @@ files:
 - lib/neco/command.rb
 - lib/neco/composition.rb
 - lib/neco/container.rb
+- lib/neco/result.rb
 - lib/neco/version.rb
 - neco.gemspec
 homepage: https://github.com/okuramasafumi/neco