modware 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3954be9354da6c601d61ef054899259b7fc749c9
-  data.tar.gz: 6840f5fa4aad0fbd2f4a97200133e12a5362bb25
+SHA256:
+  metadata.gz: 507056ec7b90b4f35ca6e927bfa72241176258fb4a33a83d62565920831cff3b
+  data.tar.gz: 46596689ab31ae28d5dad8cdcf800578fb25b51f42679a9a69e0f45ba1bcf7e2
 SHA512:
-  metadata.gz: 997889d2b9aed15eabab7ebc41f85f52ba1be4213d2cdcd44ab562ce5245c75c6a3b0d9e87515b02b4387eea34e2305c8c841ee93324c8b76319953f4ab2f803
-  data.tar.gz: 0cfe6a6036f066df4794e96944ac42750f4249d1d4a13da5482412fd63cc9bd051de7e7a7f419cc9c67805cec360ee8eb53bfa104f29c18935c2828599e9887f
+  metadata.gz: d9fddb563c69665eb4a4199bda7c0d8cd7f943c06c3865f98c9f9d45eff4992d13bad9d4bfe2b42b54a8d6284b9d99b95b07a69002adcd683530d9b40efbde29
+  data.tar.gz: 613c1ad1d11e2b6f89498a04f1f1fbc5c5fb7a273100f7a016ae26d5ff0ed1664a30fedbdd6f43b94118c0c811954d91ce8dead71a68b7e866044aca599df11b

data/.github/workflows/prs.yml

@@ -0,0 +1,49 @@
+name: CI PR Builds
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+concurrency:
+  group: "ci-${{ github.ref }}"
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0']
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: 'Run bundle update'
+        run: bundle update
+
+      - name: Run tests
+        run: bundle exec rake spec
+
+      - name: Coveralls Parallel
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          flag-name: run-${{ matrix.ruby-version }}
+          parallel: true
+  finish:
+    needs: 'test'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Coveralls Finished
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true

data/.simplecov

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+SimpleCov.configure do
+  enable_coverage :branch
+  add_filter '/spec/'
+
+  add_group 'Libraries', '/lib/'
+
+  if ENV['CI']
+    require 'simplecov-lcov'
+
+    SimpleCov::Formatter::LcovFormatter.config do |c|
+      c.report_with_single_file = true
+      c.single_report_path = 'coverage/lcov.info'
+    end
+
+    formatter SimpleCov::Formatter::LcovFormatter
+  end
+end

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in modware.gemspec

data/README.md

@@ -1,6 +1,6 @@
 [![Gem Version](https://badge.fury.io/rb/modware.svg)](http://badge.fury.io/rb/modware)
-[![Build Status](https://secure.travis-ci.org/ronen/modware.svg)](http://travis-ci.org/ronen/modware)
-[![Coverage Status](https://img.shields.io/coveralls/ronen/modware.svg)](https://coveralls.io/r/ronen/modware)
+[![Build Status](https://github.com/SchemaPlus/modware/actions/workflows/prs.yml/badge.svg)](https://github.com/SchemaPlus/modware/actions)
+[![Coverage Status](https://coveralls.io/repos/github/SchemaPlus/modware/badge.svg)](https://coveralls.io/github/SchemaPlus/modware)
 
 # Modware
 
@@ -32,8 +32,7 @@ where `klass` is a Class for the environment instance that will be passed to the
 stack = Modware::Stack.new(env: [:name, :options, :results])
 ```
 
-and Modware will define a class that accepts those keys as keyword arguments, and has accessor methods for each (see 
-[`KeyStruct`](https://rubygems.org/gems/key_struct)).
+and Modware will define a class that accepts those keys as keyword arguments, and has accessor methods for each
 
 
 ### Defining middleware
@@ -102,7 +101,7 @@ class WrapsOperation < BaseClass
 
   attr_reader :stack
 
-  def initialized(*args)
+  def initialize(*args)
     super
     @stack = Modware::Stack.new(env: [:time, :place, :result])
   end
@@ -132,6 +131,10 @@ The [middleware](https://rubygems.org/gems/middleware) gem works well, following
 
 ## Change Log
 
+* 1.0.0 - use a major bump due to breakage with the 0.2.0 version and existing gems
+* 0.2.0 - Add ruby 3.0 support and drop ruby < 2.5 (yanked)
+* 0.1.3 - Remove its-it dependency :(  #2
+* 0.1.2 - More thread safety in Stack#start
 * 0.1.1 - Thread safety in Stack#start
 * 0.1.0 - Initial release
 

data/Rakefile

@@ -1,10 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.rspec_opts = '-Ispec'
 end
-
-require 'coveralls/rake/task'
-Coveralls::RakeTask.new
-task :spec_with_coveralls => [:spec, 'coveralls:push']

data/lib/modware/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Modware
   class StackError < Exception
   end

data/lib/modware/stack.rb

@@ -1,77 +1,92 @@
-require 'its-it'
-require 'key_struct'
+# frozen_string_literal: true
 
 module Modware
   class Stack
     def initialize(env:)
       @env_klass = case env
                    when Class then env
-                   else KeyStruct[*env]
+                   else
+                     Struct.new(*env, keyword_init: true) do
+                       def to_hash
+                         to_h.compact
+                       end
+                     end
                    end
-      @middlewares = []
+      @middleware_mods = []
     end
 
     def add(mod)
-      middleware = Middleware.new(self, mod)
-      @middlewares.last._next = middleware if @middlewares.any?
-      @middlewares << middleware
+      @middleware_mods << mod
     end
 
-    def start(*args, &implementation)
+    def start(*args, &base_implementation)
       env = @env_klass.new(*args)
-      execute_stack(env, implementation)
+      Executor.new(@middleware_mods).execute(env, base_implementation)
       env
     end
 
     private
 
-    def execute_stack(env, base_implementation)
-      return call_implementation(env, base_implementation) unless @middlewares.any?
-
-      @middlewares.each do |middleware|
-        middleware.before env if middleware.respond_to? :before
+    class Executor
+      def initialize(middleware_mods)
+        prev = nil
+        @middlewares = middleware_mods.map { |mod|
+          Middleware.new(self, mod).tap { |middleware|
+            prev._modware_next = middleware if prev
+            prev = middleware
+          }
+        }
       end
 
-      @middlewares.first._call(env, base_implementation)
+      def execute(env, base_implementation)
+        return call_implementation(env, base_implementation) if @middlewares.empty?
+
+        @middlewares.each do |middleware|
+          middleware.before env if middleware.respond_to? :before
+        end
+
+        @middlewares.first._modware_call(env, base_implementation)
 
-      @middlewares.each do |middleware|
-        middleware.after env if middleware.respond_to? :after
+        @middlewares.each do |middleware|
+          middleware.after env if middleware.respond_to? :after
+        end
       end
-    end
 
-    def call_implementation(env, base_implementation)
-      if middleware = @middlewares.select(&it.respond_to?(:implement)).last
-        middleware.implement(env)
-      elsif base_implementation
-        base_implementation.call env
-      else
-        raise StackError, "No base implementation nor middleware implementation in stack"
+      def call_implementation(env, base_implementation)
+        if middleware = @middlewares.select { |mw| mw.respond_to?(:implement) }.last
+          middleware.implement(env)
+        elsif base_implementation
+          base_implementation.call env
+        else
+          raise StackError, "No base implementation nor middleware implementation in stack"
+        end
       end
     end
 
+
     class Middleware
-      attr_accessor :_next
+      attr_accessor :_modware_next
 
-      def initialize(stack, mod)
-        @stack = stack
+      def initialize(executor, mod)
+        @executor = executor
         singleton_class.send :include, mod
       end
 
-      def _call(env, base_implementation)
+      def _modware_call(env, base_implementation)
         if respond_to? :around
           around(env) { |env|
-            _continue env, base_implementation
+            _modware_continue env, base_implementation
           }
         else
-          _continue env, base_implementation
+          _modware_continue env, base_implementation
         end
       end
 
-      def _continue(env, base_implementation)
-        if self._next
-          self._next._call(env, base_implementation)
+      def _modware_continue(env, base_implementation)
+        if self._modware_next
+          self._modware_next._modware_call(env, base_implementation)
         else
-          @stack.send :call_implementation, env, base_implementation
+          @executor.call_implementation env, base_implementation
         end
       end
     end

data/lib/modware/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Modware
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

data/lib/modware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "modware/errors"
 require "modware/stack"
 require "modware/version"

data/modware.gemspec

@@ -1,4 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'modware/version'
@@ -17,15 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.1.0"
-  spec.add_dependency "key_struct", "~> 0.4"
-  spec.add_dependency "its-it"
+  spec.required_ruby_version = ">= 2.5.0"
 
-  spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-given"
   spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "simplecov-gem-profile"
+  spec.add_development_dependency 'simplecov-lcov', '~> 0.8.0'
 end

data/spec/env_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe "Env" do

data/spec/execution_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe "Execution" do
@@ -13,7 +15,7 @@ describe "Execution" do
 
   context "when start with base implementation" do
 
-    When(:env) { stack.start result: [] { |env| env.result << :base } }
+    When(:env) { stack.start(result: []) { |env| env.result << :base } }
 
     Then { expect(env.result).to eq [:base] }
 
@@ -28,6 +30,13 @@ describe "Execution" do
         Given { stack.add Factory.middleware(2, implement: nil) }
 
         Then { expect(env.result).to eq [:before1, :before2, :around_pre2, :implement1, :around_post2, :after1, :after2 ] }
+
+        context "if add middleware3" do
+
+          Given { stack.add Factory.middleware(3, around: nil, implement: nil) }
+
+          Then { expect(env.result).to eq [:before1, :before2, :before3, :around_pre2, :implement1, :around_post2, :after1, :after2, :after3 ] }
+        end
       end
     end
 

data/spec/helper_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe "Helper" do
@@ -7,12 +9,12 @@ describe "Helper" do
   context "Modware.is_middleware?" do
     [:before, :after, :around, :implement].each do |method|
       it "returns truthy for a module with #{method.inspect} method" do
-        expect(Modware.is_middleware? Factory.middleware(none.merge(method => true))).to be_truthy
+        expect(Modware.is_middleware? Factory.middleware(**none.merge(method => true))).to be_truthy
       end
     end
 
     it "returns falsey for other modules" do
-      expect(Modware.is_middleware? Factory.middleware(none.merge(other: true))).to be_falsey
+      expect(Modware.is_middleware? Factory.middleware(**none.merge(other: true))).to be_falsey
     end
   end
 

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 require 'simplecov'
-require 'simplecov-gem-profile'
-SimpleCov.start "gem"
+SimpleCov.start
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))

data/spec/support/factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Factory
   def self.middleware(n=nil, before: true, after: true, around: true, implement: true, other: nil)
 
@@ -35,6 +37,8 @@ module Factory
       end
     END
 
-    Module.new.tap(&it.module_eval(methods.compact.join))
+    Module.new do
+      module_eval(methods.compact.join)
+    end
   end
 end

metadata

@@ -1,45 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: modware
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - ronen barzel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-25 00:00:00.000000000 Z
+date: 2022-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: key_struct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: its-it
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,34 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -123,28 +81,29 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov-gem-profile
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: 0.8.0
+description:
 email:
 - ronen@barzel.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/prs.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".simplecov"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -163,7 +122,7 @@ homepage: https://github.com/ronen/modware
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -171,16 +130,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: A middleware library, featuring a simple interface and "callback" style semantics
   in the middleware stack

data/.travis.yml

@@ -1,7 +0,0 @@
-sudo: false
-rvm:
-  - 2.1.5
-script: bundle exec rake spec_with_coveralls
-notifications:
-  recipients:
-    - ronen@barzel.org