gracefully 0.0.1 → 0.1.0

data/spec/spec_helper.rb

@@ -21,3 +21,6 @@ RSpec.configure do |config|
 
   Kernel.srand config.seed
 end
+
+require 'coveralls'
+Coveralls.wear!

data/spec/timecop_helper.rb

@@ -0,0 +1,3 @@
+require 'timecop'
+
+Timecop.safe_mode = true

data/spec/timed_command_spec.rb

@@ -0,0 +1,73 @@
+require 'gracefully'
+require 'gracefully/command'
+require 'gracefully/timed_command'
+
+RSpec.shared_examples "a timed command" do
+  let(:input1) {
+    'input1'
+  }
+
+  let(:callable) {
+    Gracefully::Command.new(&usually)
+  }
+
+  context 'when the block given to the command succeeds without any error' do
+    let(:usually) {
+      -> arg1 { 'usually:arg1:' + arg1 }
+    }
+
+    it { is_expected.to eq('usually:arg1:input1') }
+  end
+
+  context 'when the usually block fails with an error' do
+    let(:usually) {
+      -> arg1 { raise 'simulated error' }
+    }
+
+    specify { expect { subject }.to raise_error('simulated error') }
+  end
+
+  context 'when the usually block call takes longer than the time out period' do
+    let(:usually) {
+      -> arg1 { sleep(0.1) }
+    }
+
+    specify { expect { subject }.to raise_error(Timeout::Error) }
+  end
+end
+
+RSpec.describe Gracefully::TimedCommand do
+  context "command creation with invalid number of arguments" do
+    subject {
+      described_class.new(1, 2, 3)
+    }
+
+    specify { expect { subject }.to raise_error(/Invalid number of arguments: 3/) }
+  end
+
+  describe "feature call result" do
+    context 'made of a callable object' do
+      subject {
+        described_class.new(usually, timeout: 0.01).call input1
+      }
+
+      it_behaves_like 'a timed command'
+    end
+
+    context 'made of a command' do
+      subject {
+        described_class.new(callable, timeout: 0.01).call input1
+      }
+
+      it_behaves_like 'a timed command'
+    end
+
+    context 'made of a block' do
+      subject {
+        described_class.new(timeout: 0.01, &usually).call input1
+      }
+
+      it_behaves_like 'a timed command'
+    end
+  end
+end

data/spec/togglable_command_spec.rb

@@ -0,0 +1,31 @@
+require 'gracefully/togglable_command'
+
+RSpec.describe Gracefully::TogglableCommand do
+  subject {
+    described_class.new(run_only_if: -> { current_user == target_user }) { |a| a + ' modified' }.call arg
+  }
+
+  let(:arg) {
+    'input'
+  }
+
+  let(:current_user) {
+    'mikoto'
+  }
+
+  context 'when the `run_only_if` block returns true' do
+    let(:target_user) {
+      'mikoto'
+    }
+
+    it { is_expected.to eq('input modified') }
+  end
+
+  context 'when the `run_only_if` block returns false' do
+    let(:target_user) {
+      'kuroko'
+    }
+
+    specify { expect { subject }.to raise_error(Gracefully::CommandDisabledError) }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gracefully
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Yusuke KUOKA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-22 00:00:00.000000000 Z
+date: 2014-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -47,20 +47,44 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - gracefully.gemspec
 - lib/gracefully.rb
-- lib/gracefully/feature.rb
-- lib/gracefully/feature_builder.rb
+- lib/gracefully/all.rb
+- lib/gracefully/circuit_breaker.rb
+- lib/gracefully/command.rb
+- lib/gracefully/command_disabled_error.rb
+- lib/gracefully/consecutive_failures_based_health.rb
+- lib/gracefully/counter.rb
+- lib/gracefully/degradable.rb
+- lib/gracefully/degradable_command.rb
+- lib/gracefully/degradable_command_builder.rb
+- lib/gracefully/error.rb
 - lib/gracefully/feature_repository.rb
-- lib/gracefully/health_meter.rb
+- lib/gracefully/health.rb
+- lib/gracefully/mutex_based_synchronized_counter.rb
+- lib/gracefully/retried_command.rb
+- lib/gracefully/short_circuited_command.rb
+- lib/gracefully/timed_command.rb
+- lib/gracefully/togglable_command.rb
 - lib/gracefully/try.rb
 - lib/gracefully/version.rb
+- spec/circuit_breaker_spec.rb
+- spec/command_spec.rb
+- spec/consecutive_failures_based_health_spec.rb
+- spec/degradable_spec.rb
 - spec/gracefully_spec.rb
+- spec/mutex_based_synchronized_counter_spec.rb
+- spec/retried_command_spec.rb
+- spec/short_circuited_command_spec.rb
 - spec/spec_helper.rb
+- spec/timecop_helper.rb
+- spec/timed_command_spec.rb
+- spec/togglable_command_spec.rb
 homepage: https://github.com/crowdworks/gracefully
 licenses:
 - MIT
@@ -86,5 +110,15 @@ signing_key:
 specification_version: 4
 summary: ensures features gracefully degrade based on error rate or turnaround time.
 test_files:
+- spec/circuit_breaker_spec.rb
+- spec/command_spec.rb
+- spec/consecutive_failures_based_health_spec.rb
+- spec/degradable_spec.rb
 - spec/gracefully_spec.rb
+- spec/mutex_based_synchronized_counter_spec.rb
+- spec/retried_command_spec.rb
+- spec/short_circuited_command_spec.rb
 - spec/spec_helper.rb
+- spec/timecop_helper.rb
+- spec/timed_command_spec.rb
+- spec/togglable_command_spec.rb

data/lib/gracefully/feature_builder.rb

@@ -1,24 +0,0 @@
-module Gracefully
-  class FeatureBuilder
-    def initialize(feature_name)
-      @feature_name = feature_name
-    end
-
-    def usually(&block)
-      @usually = block
-      self
-    end
-
-    def fallback_to(&block)
-      @fallback_to = block
-
-      build
-    end
-
-    private
-
-    def build
-      Feature.new(name: @feature_name, usually: @usually, fallback_to: @fallback_to)
-    end
-  end
-end

data/lib/gracefully/health_meter.rb

@@ -1,90 +0,0 @@
-module Gracefully
-  class HealthMeter
-    def initialize(args)
-      @healthy_count = 0
-      @unhealthy_count = 0
-      @state = Healthy.new configuration: args[:configuration]
-    end
-
-    def mark_healthy
-      @state = @state.mark_healthy
-    end
-
-    def mark_unhealthy
-      @state = @state.mark_unhealthy
-    end
-
-    def healthy?
-      @state.healthy?
-    end
-
-    def unhealthy?
-      @state.unhealthy?
-    end
-
-    class State
-      def unhealthy?
-        !healthy?
-      end
-    end
-
-    class Configuration
-      attr_reader :healthy_threshold, :unhealthy_threshold
-
-      def initialize(args)
-        @healthy_threshold = args[:healthy_threshold]
-        @unhealthy_threshold = args[:unhealthy_threshold]
-      end
-    end
-
-    class Healthy < State
-      def initialize(args)
-        @unhealthy_count = 0
-        @configuration = args[:configuration]
-      end
-
-      def mark_healthy
-        self
-      end
-
-      def mark_unhealthy
-        @unhealthy_count += 1
-
-        if @unhealthy_count <= @configuration.unhealthy_threshold
-          self
-        else
-          Unhealthy.new configuration: @configuration
-        end
-      end
-
-      def healthy?
-        true
-      end
-    end
-
-    class Unhealthy < State
-      def initialize(args)
-        @healthy_count = 0
-        @configuration = args[:configuration]
-      end
-
-      def mark_healthy
-        @healthy_count += 1
-
-        if @healthy_count <= @configuration.healthy_threshold
-          self
-        else
-          Healthy.new configuration: @configuration
-        end
-      end
-
-      def mark_unhealthy
-        self
-      end
-
-      def healthy?
-        false
-      end
-    end
-  end
-end