neco 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a76769c86da347b95edf51478953e8df04d2eb2ab97f19e7dfd995a05017c9d
-  data.tar.gz: 5c1d9f6613159a5ceba4c61a3dd38e50de5925b6b760c87cd894500051eaa3b8
+  metadata.gz: 5b8600b54de50cbf86de418e8ac297f91ca7944829ad55a970c212f7ebe9f3bc
+  data.tar.gz: 0b96f25e550ce59eff7822f73173da69198c6c6ad2db83fa7b8f0b5c30b9e224
 SHA512:
-  metadata.gz: d04fd9578ff50db4c6289c13855094ad60865d29ccae1fc10c0e2fc6885e9096e192c2647a13b4610886d5de8e0109271d847489e7697a82aa01a2077ca7bf55
-  data.tar.gz: e2e49ae215916a6784f422abb0bd2bedc2de97e5ce5be4913ec1d8c7e83fa92c24e917b8faf082e955cd45ffb451f038a1a4be3db2b7fd60a663c648ae623a71
+  metadata.gz: '05398284cdd89b706c5c37134fabf33ee97475396555c8a49f264e0595efec4ba80d4ee69b2cc980b107e340e69467d13154cec84e1faffe167e96d5f0ccc9ea'
+  data.tar.gz: d0a0fe2de63bcb45e152a94112ef5470610bc9e4e18d3a8616bfc0617388e08598e0452e65caa56e5cee9e574206b643fd8143be5f96939c800f8cbbaf00ae42

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
   TargetRubyVersion: 2.6
+  Exclude:
+    - 'examples/**/*.rb'
 
 Style/DoubleNegation:
   Enabled: false

data/Gemfile.lock

@@ -1,17 +1,22 @@
 PATH
   remote: .
   specs:
-    neco (0.0.1)
+    neco (0.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
+    coderay (1.1.2)
     jaro_winkler (1.5.2)
+    method_source (0.9.2)
     minitest (5.11.3)
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rainbow (3.0.0)
     rake (10.5.0)
     rubocop (0.70.0)
@@ -31,6 +36,7 @@ DEPENDENCIES
   bundler (~> 2.0)
   minitest (~> 5.0)
   neco!
+  pry (>= 0.12.2)
   rake (~> 10.0)
   rubocop (>= 0.70.0)
 

data/bin/console

@@ -8,8 +8,8 @@ require 'neco'
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+require 'pry'
+Pry.start
 
-require 'irb'
-IRB.start(__FILE__)
+# require 'irb'
+# IRB.start(__FILE__)

data/examples/command.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'neco'
+
+# An example class for validation and main logic
+# with block parameter.
+class Foo
+  include Neco::Command
+
+  validates do |name:|
+    name == 'Tama'
+  end
+
+  main do |name:|
+    puts "Hello, #{name}!"
+  end
+end
+
+Foo.call(name: 'Tama')
+Foo.call(name: 'Pochi')
+Foo.new.call(name: 'Tama')
+Foo.new(name: 'Pochi').call
+
+class Bar
+  include Neco::Command
+
+  main do |answer|
+    puts "The ultimate answer is #{answer}"
+  end
+end
+
+Bar.call(42)
+Bar.new(42).call
+
+class Buzz
+  include Neco::Command
+
+  main do |user:, params: nil|
+    user.update(params)
+    p "User is now #{user}"
+  end
+end
+
+Buzz.new(user: {}).call(params: {name: 'Tama'})

data/examples/composition.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'neco'
+
+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

data/lib/neco.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'neco/version'
+require 'neco/command'
+require 'neco/composition'
 
 module Neco
   class Error < StandardError; end

data/lib/neco/command.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'neco/container'
+
+module Neco
+  # Command module is a basic module of Neco.
+  # It provides many DSLs for validating input, executing business logic,
+  # handling errors and much more.
+  module Command
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        include InstanceMethods
+      end
+    end
+
+    # DSLs
+    module ClassMethods
+      def main(&blk)
+        @main = blk
+      end
+
+      def validates(&blk)
+        @validation = blk
+      end
+
+      def rollback(&blk)
+        @rollback = blk
+      end
+
+      def call(*args, **params)
+        instance = new(*args, **params)
+        instance.call
+        true
+      end
+    end
+
+    # When command object is instantiated, either by a class-level call,
+    # a container or a user, these methods will be called.
+    module InstanceMethods
+      def initialize(*args, container: FakeContainer.new(command: self), **params)
+        @args = args
+        @container = container
+        @params = params
+      end
+
+      def set(key, value)
+        @container.set(key, value)
+      end
+
+      def call(*args, **params)
+        @args += args
+        @params.merge!(params)
+
+        return false unless validate
+
+        main = self.class.instance_variable_get(:@main)
+        instance_exec(*@args, **@params, &main)
+      end
+
+      def validate
+        validation = self.class.instance_variable_get(:@validation)
+        validation ? validation.call(@args, @params) : true
+      end
+
+      def revert
+        rollback = self.class.instance_variable_get(:@rollback)
+        instance_exec(*@args, **@params, &rollback)
+      end
+
+      def to_s
+        main = self.class.instance_variable_get(:@main)
+        main.inspect
+      end
+
+      def inspect
+        to_s
+      end
+    end
+
+    # @private
+    class FakeContainer
+      def initialize(command:)
+        @command = command
+        @environment = {}
+      end
+
+      def set(key, value)
+        @environment[key] = value
+      end
+    end
+    private_constant :FakeContainer
+  end
+end

data/lib/neco/composition.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'neco/container'
+
+module Neco
+  # Composition is a module for users to compose multiple commands.
+  module Composition
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+      end
+    end
+
+    # DSLs for composition pattern.
+    # `compose` is meant to be used in a class definition
+    # while `call` is meant to be used when users actually execute commands.
+    module ClassMethods
+      def composes(*commands)
+        @container = Container.new(commands: commands)
+      end
+
+      def call(*args, **params)
+        @container.call(args, params)
+      end
+    end
+  end
+end

data/lib/neco/container.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Neco
+  # Container has two purposes.
+  # One is to store commands and execute rollbacks when one command raises an exception.
+  # Another is to store environment hash for those commands so that commands can pass data between them.
+  class Container
+    def initialize(commands: [], environment: {})
+      @commands = commands.map {|command| command.new(container: self) }
+      @environment = environment
+      @called = []
+    end
+
+    def call(*args, **params)
+      @environment.merge!(params)
+      @commands.each do |command|
+        command.call(*args, **@environment)
+        @called << command
+      rescue StandardError
+        @called.reverse_each(&:revert)
+        break
+      end
+    end
+
+    def set(key, value)
+      @environment[key] = value
+    end
+  end
+end

data/lib/neco/version.rb

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

data/neco.gemspec

@@ -29,6 +29,7 @@ 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 'rubocop', '>= 0.70.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neco
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2019-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,7 +100,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/command.rb
+- examples/composition.rb
 - lib/neco.rb
+- lib/neco/command.rb
+- lib/neco/composition.rb
+- lib/neco/container.rb
 - lib/neco/version.rb
 - neco.gemspec
 homepage: https://github.com/okuramasafumi/neco