simple-service 0.1.5

data/spec/simple/service/action_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+describe Simple::Service::Action do
+  let(:service) { SpecService }
+
+  let(:service1) { ::Simple::Service.action(service, :service1) }
+  let(:service2) { ::Simple::Service.action(service, :service2) }
+  let(:service3) { ::Simple::Service.action(service, :service3) }
+
+  describe "attributes" do
+    describe "#service" do
+      it "returns the service module" do
+        expect(service1.service).to eq(service)
+      end
+    end
+
+    describe "#name" do
+      it "returns the action name" do
+        expect(service1.name).to eq(:service1)
+      end
+    end
+
+    describe "full_name" do
+      it "returns the full_name" do
+        expect(service1.full_name).to eq("SpecService#service1")
+      end
+    end
+
+    describe "to_s" do
+      it "returns the full_name" do
+        expect(service1.to_s).to eq("SpecService#service1")
+      end
+    end
+
+    describe "#short_description" do
+      it "returns the short_description as per source code" do
+        expect(service1.short_description).to eq("This is service1")
+        expect(service2.short_description).to eq("This is service2 (no full description)")
+        expect(service3.short_description).to eq(nil)
+      end
+    end
+
+    describe "#full_description" do
+      it "returns the full_description as per source code" do
+        expect(service1.full_description).to eq("Service 1 has a full description")
+        expect(service2.full_description).to eq(nil)
+        expect(service3.full_description).to eq(nil)
+      end
+    end
+  end
+end

data/spec/simple/service/context_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+describe Simple::Service do
+  describe ".with_context" do
+    it "merges the current context for the duration of the block" do
+      block_called = false
+
+      Simple::Service.with_context(a: "a") do
+        expect(Simple::Service.context.a).to eq("a")
+
+        # overwrite value
+        Simple::Service.with_context(a: "b") do
+          expect(Simple::Service.context.a).to eq("b")
+          block_called = true
+        end
+
+        # overwrite value w/nil
+        Simple::Service.with_context(a: nil) do
+          expect(Simple::Service.context.a).to be_nil
+          Simple::Service.context.a = "c"
+          expect(Simple::Service.context.a).to eq("c")
+        end
+        expect(Simple::Service.context.a).to eq("a")
+      end
+
+      expect(block_called).to eq(true)
+    end
+  end
+end
+
+describe Simple::Service::Context do
+  let(:context) { Simple::Service::Context.new }
+
+  before do
+    context.one = 1
+  end
+
+  describe "invalid identifier" do
+    it "raises an error" do
+      expect { context.one! }.to raise_error(NoMethodError)
+    end
+  end
+
+  describe "context reading" do
+    it "returns a value if set" do
+      expect(context.one).to eq(1)
+    end
+
+    it "returns nil if not set" do
+      expect(context.two).to be_nil
+    end
+  end
+
+  describe "context writing" do
+    it "sets a value if it does not exist yet" do
+      context.two = 2
+      expect(context.two).to eq(2)
+    end
+
+    it "raises a ReadOnly error if the value exists and is not equal" do
+      expect { context.one = 2 }.to raise_error(::Simple::Service::ContextReadOnlyError)
+    end
+
+    it "sets the value if it exists and is equal" do
+      context.one = 1
+      expect(context.one).to eq(1)
+    end
+  end
+end

data/spec/simple/service/service_spec.rb

@@ -0,0 +1,156 @@
+require "spec_helper"
+
+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)
+      end
+    end
+
+    describe ".action" do
+      it "raises an argument error" do
+        expect { Simple::Service.action(service, :service1) }.to raise_error(ArgumentError)
+      end
+    end
+
+    describe ".invoke3" do
+      it "raises an argument error" do
+        ::Simple::Service.with_context do
+          expect { Simple::Service.invoke3(service, :service1, {}, {}, context: nil) }.to raise_error(::ArgumentError)
+        end
+      end
+    end
+  end
+
+  # 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)
+      expect(actions).to be_a(Hash)
+      expect(actions.keys).to contain_exactly(:service1, :service2, :service3)
+    end
+  end
+
+  describe ".action" do
+    context "with an existing name" do
+      it "returns a Action object" do
+        action = Simple::Service.action(service, :service1)
+        expect(action.service).to eq(service)
+        expect(action.name).to eq(:service1)
+      end
+    end
+
+    describe "Simple::Service::NoSuchAction" do
+      it "does not inherit from Simple::Service::ArgumentError" do
+        expect(Simple::Service::NoSuchAction < Simple::Service::ArgumentError).to be_falsey
+      end
+
+      it "inherits from ArgumentError" do
+        expect(Simple::Service::NoSuchAction < ::ArgumentError).to eq true
+      end
+    end
+
+    context "with an unknown name" do
+      it "raises a NoSuchAction error" do
+        expect do
+          Simple::Service.action(service, :no_such_service)
+        end.to raise_error(Simple::Service::NoSuchAction, /No such action :no_such_service/)
+      end
+    end
+  end
+
+  describe '.invoke3' do
+    def invoke3
+      Simple::Service.invoke3(service, :service1, "my_a", "my_b", d: "my_d")
+    end
+
+    context "when context is not set" do
+      it "raises a ContextMissingError" do
+        action = Simple::Service.actions(service)[:service1]
+        expect(action).not_to receive(:invoke)
+
+        expect do
+          invoke3
+        end.to raise_error(::Simple::Service::ContextMissingError)
+      end
+    end
+
+    context "when context is set" do
+      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" })
+
+        ::Simple::Service.with_context do
+          invoke3
+        end
+      end
+    end
+  end
+
+  describe ".invoke" do
+    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
+          action = Simple::Service.actions(service)[:service1]
+          expect(action).not_to receive(:invoke)
+
+          expect do
+            invoke
+          end.to raise_error(::Simple::Service::ContextMissingError)
+        end
+      end
+
+      context "when context is set" do
+        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" }).and_call_original
+
+          ::Simple::Service.with_context do
+            invoke
+          end
+        end
+      end
+    end
+  end
+
+  describe "documentation example" do
+    def invoke(*args, **flags)
+      Simple::Service.invoke(SpecTestService, :foo, *args, **flags)
+    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"]
+      ::Simple::Service.with_context do
+      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
+end

data/spec/simple/service/version_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe "Simple::Service::VERSION" do
+  it "returns a version number" do
+    expect(Simple::Service::VERSION).to match(/\d\.\d\.\d/)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+ENV["RACK_ENV"] = "test"
+ENV["RAILS_ENV"] = "test"
+
+require "byebug"
+require "rspec"
+
+require "simplecov"
+
+SimpleCov.start do
+  # return true to remove src from coverage
+  add_filter do |src|
+    next true if src.filename =~ /\/spec\//
+
+    false
+  end
+
+  # minimum_coverage 90
+end
+
+require "simple/service"
+
+Dir.glob("./spec/support/**/*.rb").sort.each { |path| load path }
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run focus: (ENV["CI"] != "true")
+  config.expect_with(:rspec) { |c| c.syntax = :expect }
+  config.order = "random"
+  config.example_status_persistence_file_path = ".rspec.data"
+
+  config.backtrace_exclusion_patterns << /spec\/support/
+  config.backtrace_exclusion_patterns << /spec\/helpers/
+  config.backtrace_exclusion_patterns << /spec_helper/
+
+  # config.around(:each) do |example|
+  #   example.run
+  # end
+end

data/spec/support/spec_services.rb

@@ -0,0 +1,58 @@
+# rubocop:disable Naming/UncommunicativeMethodParamName
+
+module NoServiceModule
+end
+
+module SpecService
+  include Simple::Service
+
+  # This is service1
+  #
+  # Service 1 has a full description
+  def service1(a, b, c = "speed-of-light", d:, e: 2.781); end
+
+  # This is service2 (no full description)
+  def service2
+    "service2 return"
+  end
+
+  def service3
+    nil
+  end
+
+  private
+
+  def not_a_service; end
+end
+
+module InvokeTestService
+  include Simple::Service
+
+  def no_params
+    "service2 return"
+  end
+
+  def positional_params(a, b, c = "speed-of-light", e = 2.781)
+    [a, b, c, e]
+  end
+
+  def named_params(a:, b:, c: "speed-of-light", e: 2.781)
+    [a, b, c, e]
+  end
+
+  def mixed_optional_params(a, b = "default-b", c = "speed-of-light", e: 2.781)
+    [a, b, c, e]
+  end
+
+  def variadic_params(a, b = "queen bee", *args, e: 2.781)
+    [a, b, args, e]
+  end
+end
+
+module SpecTestService
+  include Simple::Service
+
+  def foo(bar, baz:)
+    [ bar, baz ]
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: simple-service
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- radiospiel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: expectation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Pretty simple and somewhat abstract service description
+email: eno@radiospiel.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".tm_properties"
+- Gemfile
+- Makefile
+- README.md
+- Rakefile
+- 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/IndieHash.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_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/service.rb
+- lib/simple/service/action.rb
+- lib/simple/service/action/comment.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
+- log/.gitkeep
+- scripts/release
+- scripts/release.rb
+- scripts/stats
+- scripts/watch
+- simple-service.gemspec
+- 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/spec_helper.rb
+- spec/support/spec_services.rb
+homepage: http://github.com/radiospiel/simple-service
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Pretty simple and somewhat abstract service description
+test_files:
+- 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/spec_helper.rb
+- spec/support/spec_services.rb