simple-service 0.1.3 → 0.2.0

data/spec/simple/service/service_spec.rb

@@ -1,15 +1,11 @@
 require "spec_helper"
 
+# rubocop:disable Style/WordArray
+
 describe "Simple::Service" do
   context "when running against a NoService module" do
     let(:service) { NoServiceModule }
 
-    describe ".service?" do
-      it "returns false on a NoService module" do
-        expect(Simple::Service.service?(service)).to eq(false)
-      end
-    end
-
     describe ".actions" do
       it "raises an argument error" do
         expect { Simple::Service.actions(service) }.to raise_error(ArgumentError)
@@ -22,11 +18,9 @@ describe "Simple::Service" do
       end
     end
 
-    describe ".invoke" do
+    describe ".invoke3" do
       it "raises an argument error" do
-        ::Simple::Service.with_context do
-          expect { Simple::Service.invoke(service, :service1, {}, {}, context: nil) }.to raise_error(::ArgumentError)
-        end
+        expect { Simple::Service.invoke3(service, :service1, {}, {}, context: nil) }.to raise_error(::ArgumentError)
       end
     end
   end
@@ -34,12 +28,6 @@ describe "Simple::Service" do
   # running against a proper service module
   let(:service) { SpecService }
 
-  describe ".service?" do
-    it "returns true" do
-      expect(Simple::Service.service?(service)).to eq(true)
-    end
-  end
-
   describe ".actions" do
     it "returns a Hash of actions on a Service module" do
       actions = Simple::Service.actions(service)
@@ -76,30 +64,50 @@ describe "Simple::Service" do
     end
   end
 
+  describe ".invoke3" do
+    def invoke3
+      Simple::Service.invoke3(service, :service1, "my_a", "my_b", d: "my_d")
+    end
+
+    it "calls Action#invoke with the right arguments" do
+      action = Simple::Service.actions(service)[:service1]
+      expect(action).to receive(:invoke).with(args: ["my_a", "my_b"], flags: { "d" => "my_d" })
+
+      invoke3
+    end
+  end
+
   describe ".invoke" do
-    let(:positionals) { { a: "my_a", b: "my_b" } }
-    let(:named) { { d: "my_d" } }
+    context "with a args array" do
+      def invoke
+        Simple::Service.invoke(service, :service1, args: ["my_a", "my_b"], flags: { "d" => "my_d" })
+      end
 
-    context "when context is not set" do
-      it "raises a ContextMissingError" do
+      it "calls Action#invoke with the right arguments" do
         action = Simple::Service.actions(service)[:service1]
-        expect(action).not_to receive(:invoke)
+        expect(action).to receive(:invoke).with(args: ["my_a", "my_b"], flags: { "d" => "my_d" }).and_call_original
 
-        expect do
-          Simple::Service.invoke(service, :service1, *positionals, named_args: named)
-        end.to raise_error(::Simple::Service::ContextMissingError)
+        invoke
       end
     end
+  end
 
-    context "when context is not set" do
-      it "properly delegates call to action object" do
-        action = Simple::Service.actions(service)[:service1]
-        expect(action).to receive(:invoke).with(*positionals, named_args: named)
+  describe "documentation example" do
+    def invoke(*args, **flags)
+      Simple::Service.invoke(SpecTestService, :foo, *args, **flags)
+    end
 
-        ::Simple::Service.with_context do
-          Simple::Service.invoke(service, :service1, *positionals, named_args: named)
-        end
-      end
+    def invoke3(*args, **flags)
+      Simple::Service.invoke3(SpecTestService, :foo, *args, **flags)
+    end
+
+    it "calls Action#invoke with the right arguments" do
+      expected = ["bar-value", "baz-value"]
+
+      expect(invoke3("bar-value", baz: "baz-value")).to eq(expected)
+      expect(invoke3(bar: "bar-value", baz: "baz-value")).to eq(expected)
+      expect(invoke(args: ["bar-value"], flags: { "baz" => "baz-value" })).to eq(expected)
+      expect(invoke(args: { "bar" => "bar-value", "baz" => "baz-value" })).to eq(expected)
     end
   end
 end

data/spec/simple/workflow/context_spec.rb

@@ -0,0 +1,90 @@
+require "spec_helper"
+
+describe Simple::Workflow::Context do
+  RSpec.shared_examples "context requesting" do
+    it "inherits from Simple::Immutable" do
+      expect(context).to be_a(Simple::Immutable)
+    end
+
+    describe "checking for identifier" do
+      it "raises an ArgumentError if the key is invalid" do
+        expect { context.oneTwoThree? }.to raise_error(ArgumentError)
+      end
+
+      it "returns nil if the key is not set" do
+        expect(context.two?).to be_nil
+      end
+
+      it "returns the value if the key is set" do
+        expect(context.one?).to eq 1
+      end
+    end
+
+    describe "fetching identifier" do
+      it "raises an ArgumentError if the identifier is invalid" do
+        expect { context.one! }.to raise_error(ArgumentError)
+        expect { context.oneTwoThree }.to raise_error(ArgumentError)
+      end
+
+      it "raises a NoMethodError if the key is not set" do
+        expect { context.two }.to raise_error(NameError)
+      end
+
+      it "returns the value if the key is set" do
+        expect(context.one).to eq 1
+      end
+    end
+
+    describe "#merge" do
+      context "with symbolized keys" do
+        it "sets a value if it does not exist yet" do
+          expect(context.two?).to eq(nil)
+          new_context = Simple::Workflow::Context.new({two: 2}, context)
+          expect(new_context.two).to eq(2)
+
+          # doesn't change the source context
+          expect(context.two?).to eq(nil)
+        end
+
+        it "sets a value if it does exist" do
+          new_context = Simple::Workflow::Context.new({one: 2}, context)
+          expect(new_context.one).to eq(2)
+
+          # doesn't change the source context
+          expect(context.one).to eq(1)
+        end
+      end
+
+      context "with stringified keys" do
+        it "sets a value if it does not exist yet" do
+          expect(context.two?).to eq(nil)
+          new_context = Simple::Workflow::Context.new({"two" => 2}, context)
+          expect(new_context.two).to eq(2)
+
+          # doesn't change the source context
+          expect(context.two?).to eq(nil)
+        end
+
+        it "sets a value if it does exist" do
+          new_context = Simple::Workflow::Context.new({"one" => 2}, context)
+          expect(new_context.one).to eq(2)
+
+          # doesn't change the source context
+          expect(context.one).to eq(1)
+        end
+      end
+    end
+  end
+
+  context "with a symbolized context" do
+    let(:context) { Simple::Workflow::Context.new(one: 1) }
+
+    it_behaves_like "context requesting"
+  end
+
+  context "with a stringified context" do
+    let(:context) { Simple::Workflow::Context.new("one" => 1) }
+
+    it_behaves_like "context requesting"
+  end
+end

data/spec/simple/workflow/current_context_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe Simple::Workflow::CurrentContext do
+  describe ".with_context" do
+    it "merges the current context for the duration of the block" do
+      block_called = false
+
+      Simple::Workflow.with_context(a: "a", foo: "bar") do
+        expect(Simple::Workflow.current_context.a).to eq("a")
+        expect(Simple::Workflow.current_context.foo).to eq("bar")
+
+        # layering
+        Simple::Workflow.with_context() do
+          expect(Simple::Workflow.current_context.foo).to eq("bar")
+
+          expect(Simple::Workflow.current_context.unknown?).to be_nil
+          expect {
+            Simple::Workflow.current_context.unknown
+          }.to raise_error(NameError)
+        end
+
+        # overwrite value
+        Simple::Workflow.with_context(a: "b") do
+          expect(Simple::Workflow.current_context.a).to eq("b")
+          block_called = true
+        end
+
+        # overwrite value w/nil
+        Simple::Workflow.with_context(a: nil) do
+          expect(Simple::Workflow.current_context.a).to be_nil
+          Simple::Workflow.with_context(a: "c") do
+            expect(Simple::Workflow.current_context.a).to eq("c")
+          end
+        end
+        expect(Simple::Workflow.current_context.a).to eq("a")
+      end
+
+      expect(block_called).to eq(true)
+    end
+  end
+end

data/spec/simple/workflow/reloader_spec/example1.rb

@@ -0,0 +1,10 @@
+module ReloaderSpecExample1
+  def foo; end
+end
+
+module ReloaderSpecExample2
+end
+
+module ReloaderSpecExample3
+  def foo; end
+end

data/spec/simple/workflow/reloader_spec/example2.rb

@@ -0,0 +1,7 @@
+module ReloaderSpecExample1
+  def self.bar; end
+end
+
+module ReloaderSpecExample2
+  def self.bar; end
+end

data/spec/simple/workflow/reloader_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+require_relative "reloader_spec/example1"
+require_relative "reloader_spec/example2"
+
+describe "Simple::Service::Reloader" do
+  describe ".locate" do
+    def locate(mod)
+      Simple::Workflow::Reloader.locate(mod)
+    end
+
+    it "Returns all source files of a module" do
+      root = Dir.getwd
+
+      expected = [
+        "#{root}/lib/simple/workflow/reloader.rb"
+      ]
+      expect(locate(Simple::Workflow::Reloader)).to contain_exactly(*expected)
+
+      expected = [
+        "#{__dir__}/reloader_spec/example1.rb",
+        "#{__dir__}/reloader_spec/example2.rb"
+      ]
+      expect(locate(ReloaderSpecExample1)).to contain_exactly(*expected)
+
+      expected = [
+        "#{__dir__}/reloader_spec/example2.rb"
+      ]
+      expect(locate(ReloaderSpecExample2)).to contain_exactly(*expected)
+
+      expected = [
+        "#{__dir__}/reloader_spec/example1.rb"
+      ]
+      expect(locate(ReloaderSpecExample3)).to contain_exactly(*expected)
+    end
+  end
+
+  describe ".reload" do
+    def reload(mod)
+      Simple::Workflow::Reloader.reload(mod)
+    end
+
+    it "Reloads a module" do
+      # [TODO] this doesn't really check reloading...
+      reload Simple::Workflow::Reloader
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 ENV["RACK_ENV"] = "test"
 ENV["RAILS_ENV"] = "test"
 
-require "byebug"
+require "pry-byebug"
 require "rspec"
 
 require "simplecov"
@@ -18,6 +18,7 @@ SimpleCov.start do
 end
 
 require "simple/service"
+require "simple/workflow"
 
 Dir.glob("./spec/support/**/*.rb").sort.each { |path| load path }
 

data/spec/support/spec_services.rb

@@ -1,5 +1,3 @@
-# rubocop:disable Naming/UncommunicativeMethodParamName
-
 module NoServiceModule
 end
 
@@ -48,3 +46,11 @@ module InvokeTestService
     [a, b, args, e]
   end
 end
+
+module SpecTestService
+  include Simple::Service
+
+  def foo(bar, baz:)
+    [bar, baz]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple-service
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - radiospiel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-29 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: expectation
@@ -24,6 +24,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: simple-immutable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: Pretty simple and somewhat abstract service description
 email: eno@radiospiel.org
 executables: []
@@ -37,33 +57,74 @@ files:
 - Makefile
 - README.md
 - Rakefile
+- TODO.txt
 - VERSION
 - bin/bundle
 - bin/console
 - bin/rake
 - bin/rspec
+- doc/Simple.html
+- doc/Simple/Service.html
+- doc/Simple/Service/Action.html
+- doc/Simple/Service/Action/Comment.html
+- doc/Simple/Service/Action/Comment/Extractor.html
+- doc/Simple/Service/Action/MethodReflection.html
+- doc/Simple/Service/Action/Parameter.html
+- doc/Simple/Service/ArgumentError.html
+- doc/Simple/Service/ClassMethods.html
+- doc/Simple/Service/Context.html
+- doc/Simple/Service/ContextMissingError.html
+- doc/Simple/Service/ContextReadOnlyError.html
+- doc/Simple/Service/ExtraArguments.html
+- doc/Simple/Service/GemHelper.html
+- doc/Simple/Service/MissingArguments.html
+- doc/Simple/Service/NoSuchAction.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file.TODO.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - lib/simple-service.rb
+- lib/simple-workflow.rb
 - lib/simple/service.rb
 - lib/simple/service/action.rb
 - lib/simple/service/action/comment.rb
-- lib/simple/service/action/indie_hash.rb
 - lib/simple/service/action/method_reflection.rb
 - lib/simple/service/action/parameter.rb
-- lib/simple/service/context.rb
 - lib/simple/service/errors.rb
 - lib/simple/service/version.rb
+- lib/simple/workflow.rb
+- lib/simple/workflow/context.rb
+- lib/simple/workflow/current_context.rb
+- lib/simple/workflow/reloader.rb
+- lib/simple/workflow/rspec_helper.rb
 - log/.gitkeep
 - scripts/release
 - scripts/release.rb
 - scripts/stats
+- scripts/test
 - scripts/watch
 - simple-service.gemspec
-- spec/simple/service/action_invoke2_spec.rb
+- spec/simple/service/action_invoke3_spec.rb
 - spec/simple/service/action_invoke_spec.rb
 - spec/simple/service/action_spec.rb
-- spec/simple/service/context_spec.rb
 - spec/simple/service/service_spec.rb
 - spec/simple/service/version_spec.rb
+- spec/simple/workflow/context_spec.rb
+- spec/simple/workflow/current_context_spec.rb
+- spec/simple/workflow/reloader_spec.rb
+- spec/simple/workflow/reloader_spec/example1.rb
+- spec/simple/workflow/reloader_spec/example2.rb
 - spec/spec_helper.rb
 - spec/support/spec_services.rb
 homepage: http://github.com/radiospiel/simple-service
@@ -84,16 +145,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Pretty simple and somewhat abstract service description
 test_files:
-- spec/simple/service/action_invoke2_spec.rb
+- spec/simple/service/action_invoke3_spec.rb
 - spec/simple/service/action_invoke_spec.rb
 - spec/simple/service/action_spec.rb
-- spec/simple/service/context_spec.rb
 - spec/simple/service/service_spec.rb
 - spec/simple/service/version_spec.rb
+- spec/simple/workflow/context_spec.rb
+- spec/simple/workflow/current_context_spec.rb
+- spec/simple/workflow/reloader_spec.rb
+- spec/simple/workflow/reloader_spec/example1.rb
+- spec/simple/workflow/reloader_spec/example2.rb
 - spec/spec_helper.rb
 - spec/support/spec_services.rb

data/lib/simple/service/action/indie_hash.rb

@@ -1,37 +0,0 @@
-class Simple::Service::Action
-  # The IndieHash class defines as much of the Hash interface as necessary for simple-service
-  # to successfully run.
-  class IndieHash
-    def initialize(hsh)
-      @hsh = hsh.each_with_object({}) { |(k, v), h| h[k.to_s] = v }
-    end
-
-    def keys
-      @hsh.keys
-    end
-
-    def fetch_values(*keys)
-      keys = keys.map(&:to_s)
-      @hsh.fetch_values(*keys)
-    end
-
-    def key?(sym)
-      @hsh.key?(sym.to_s)
-    end
-
-    def [](sym)
-      @hsh[sym.to_s]
-    end
-
-    def merge(other_hsh)
-      @hsh = @hsh.merge(other_hsh.send(:__hsh__))
-      self
-    end
-
-    private
-
-    def __hsh__
-      @hsh
-    end
-  end
-end

data/lib/simple/service/context.rb

@@ -1,94 +0,0 @@
-module Simple::Service
-  # Returns the current context.
-  def self.context
-    Thread.current[:"Simple::Service.context"]
-  end
-
-  # yields a block with a given context, and restores the previous context
-  # object afterwards.
-  def self.with_context(ctx = nil, &block)
-    old_ctx = Thread.current[:"Simple::Service.context"]
-    new_ctx = old_ctx ? old_ctx.merge(ctx) : Context.new(ctx)
-
-    Thread.current[:"Simple::Service.context"] = new_ctx
-
-    block.call
-  ensure
-    Thread.current[:"Simple::Service.context"] = old_ctx
-  end
-end
-
-module Simple::Service
-  # A context object
-  #
-  # Each service executes with a current context. The system manages a stack of
-  # contexts; whenever a service execution is done the current context is reverted
-  # to its previous value.
-  #
-  # A context object can store a large number of values; the only way to set or
-  # access a value is via getters and setters. These are implemented via
-  # +method_missing(..)+.
-  #
-  # Also, once a value is set in the context it is not possible to change or
-  # unset it.
-  class Context
-    def initialize(hsh = {}) # :nodoc:
-      @hsh = hsh
-    end
-
-    # returns a new Context object, which merges the values in the +overlay+
-    # argument (which must be a Hash or nil) with the values in this context.
-    #
-    # The overlay is allowed to change values in the current context.
-    #
-    # It does not change this context.
-    def merge(overlay)
-      expect! overlay => [Hash, nil]
-
-      overlay ||= {}
-      new_context_hsh = @hsh.merge(overlay)
-      ::Simple::Service::Context.new(new_context_hsh)
-    end
-
-    private
-
-    IDENTIFIER_PATTERN = "[a-z][a-z0-9_]*" # :nodoc:
-    IDENTIFIER_REGEXP = Regexp.compile("\\A#{IDENTIFIER_PATTERN}\\z") # :nodoc:
-    ASSIGNMENT_REGEXP = Regexp.compile("\\A(#{IDENTIFIER_PATTERN})=\\z") # :nodoc:
-
-    def method_missing(sym, *args, &block)
-      raise ArgumentError, "Block given" if block
-
-      if args.count == 0 && sym =~ IDENTIFIER_REGEXP
-        self[sym]
-      elsif args.count == 1 && sym =~ ASSIGNMENT_REGEXP
-        self[$1.to_sym] = args.first
-      else
-        super
-      end
-    end
-
-    def respond_to_missing?(sym, include_private = false)
-      # :nocov:
-      return true if IDENTIFIER_REGEXP.match?(sym)
-      return true if ASSIGNMENT_REGEXP.match?(sym)
-
-      super
-      # :nocov:
-    end
-
-    def [](key)
-      @hsh[key]
-    end
-
-    def []=(key, value)
-      existing_value = @hsh[key]
-
-      unless existing_value.nil? || existing_value == value
-        raise ::Simple::Service::ContextReadOnlyError, key
-      end
-
-      @hsh[key] = value
-    end
-  end
-end