gracefully 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f736eec744523457533b32c6df2f79cc26c4c154
+  data.tar.gz: a02c22d1d338f3120bf7a712d6df7345552e7e88
+SHA512:
+  metadata.gz: 548dcba4a7645ce353bac284e57ee5b3d250f75ed40d4818bb514f71db0bd0e78af12b79979b9dfcf9bc53072f531fa8b54cd9d774cda568a5049adf35ffb291
+  data.tar.gz: b88c02168bcf7a204ae38188245cad7d655723c61a67a96e128b32815f2bb1d6dc92d95dd8d004e5a06b874153e51e630daeb6d695f4e023d236d224439dbe9e

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*~
+.idea/
+*.iml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gracefully.gemspec
+gemspec
+
+group :test do
+  gem 'rspec', '~> 3.1.0'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yusuke KUOKA
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Gracefully
+
+ensures features gracefully degrade based on error rate or turnaround time.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gracefully'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gracefully
+
+## Usage
+
+See `spec/gracefully_spec.rb` for basic usage.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/gracefully/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/gracefully.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gracefully/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gracefully"
+  spec.version       = Gracefully::VERSION
+  spec.authors       = ["Yusuke KUOKA"]
+  spec.email         = ["yusuke.kuoka@crowdworks.co.jp"]
+  spec.summary       = %q{ensures features gracefully degrade based on error rate or turnaround time.}
+  spec.homepage      = "https://github.com/crowdworks/gracefully"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/gracefully/feature.rb

@@ -0,0 +1,13 @@
+module Gracefully
+  class Feature
+    def initialize(args)
+      @name = args[:name]
+      @usually = args[:usually]
+      @fallback_to = args[:fallback_to]
+    end
+
+    def call(*args)
+      Try.to { @usually.call *args }.or_else(Try.to { @fallback_to.call *args }).get
+    end
+  end
+end

data/lib/gracefully/feature_builder.rb

@@ -0,0 +1,24 @@
+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/feature_repository.rb

@@ -0,0 +1,7 @@
+module Gracefully
+  class FeatureRepository
+    def self.instance
+      @instance
+    end
+  end
+end

data/lib/gracefully/health_meter.rb

@@ -0,0 +1,90 @@
+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

data/lib/gracefully/try.rb

@@ -0,0 +1,97 @@
+module Gracefully
+  class Try
+    def self.to(&block)
+      Unresolved.new(&block)
+    end
+  end
+
+  class Unresolved
+    def initialize(&block)
+      @block = block
+    end
+
+    def resolve
+      @resolved = begin
+        Success.with @block.call
+      rescue => e
+        Failure.with Error.new('Nested error', nested: e)
+      end
+    end
+
+    def or_else(other)
+      resolve.or_else other
+    end
+
+    def get
+      resolve.get
+    end
+  end
+
+  class Success
+    def self.with(result)
+      new result
+    end
+
+    def initialize(result)
+      @result = result
+    end
+
+    def or_else(other)
+      self
+    end
+
+    def get
+      @result
+    end
+  end
+
+  class Failure
+    def self.with(error)
+      new error
+    end
+
+    def initialize(error)
+      @error = error
+    end
+
+    def or_else(other)
+      other
+    end
+
+    def get
+      raise @error
+    end
+  end
+
+  # Thanks to [nested](https://github.com/skorks/nesty) for the original code
+  module NestedError
+    def initialize(message, args)
+      @nested = args[:nested]
+      super(message)
+    end
+
+    def set_backtrace(backtrace)
+      @raw_backtrace = backtrace
+      if nested
+        backtrace = backtrace - nested_raw_backtrace
+        backtrace += ["#{nested.backtrace.first}: #{nested.message} (#{nested.class.name})"]
+        backtrace += nested.backtrace[1..-1] || []
+      end
+      super(backtrace)
+    end
+
+    private
+
+    def nested_raw_backtrace
+      nested.respond_to?(:raw_backtrace) ? nested.raw_backtrace : nested.backtrace
+    end
+
+    def nested
+      @nested
+    end
+  end
+
+  class Error < StandardError
+    include NestedError
+  end
+end

data/lib/gracefully/version.rb

@@ -0,0 +1,3 @@
+module Gracefully
+  VERSION = "0.0.1"
+end

data/lib/gracefully.rb

@@ -0,0 +1,10 @@
+require "gracefully/version"
+require "gracefully/feature"
+require "gracefully/feature_builder"
+require "gracefully/try"
+
+module Gracefully
+  def self.degrade(feature_name)
+    FeatureBuilder.new(feature_name)
+  end
+end

data/spec/gracefully_spec.rb

@@ -0,0 +1,43 @@
+require 'gracefully'
+
+RSpec.describe Gracefully do
+  describe "feature call result" do
+    subject {
+      Gracefully.
+        degrade(feature_name).
+        usually(&usually).
+        fallback_to(&fallback_to).
+        call input1
+    }
+
+    let(:input1) {
+      'input1'
+    }
+
+    let(:fallback_to) {
+      -> arg1 { 'fallback:arg1:' + arg1 }
+    }
+
+    context 'when the feature is defined for the name' do
+      let(:feature_name) {
+        :the_feature
+      }
+
+      context 'when the usually block 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' }
+        }
+
+        it { is_expected.to eq('fallback:arg1:input1') }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: gracefully
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yusuke KUOKA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-22 00:00:00.000000000 Z
+dependencies:
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- yusuke.kuoka@crowdworks.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gracefully.gemspec
+- lib/gracefully.rb
+- lib/gracefully/feature.rb
+- lib/gracefully/feature_builder.rb
+- lib/gracefully/feature_repository.rb
+- lib/gracefully/health_meter.rb
+- lib/gracefully/try.rb
+- lib/gracefully/version.rb
+- spec/gracefully_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/crowdworks/gracefully
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: ensures features gracefully degrade based on error rate or turnaround time.
+test_files:
+- spec/gracefully_spec.rb
+- spec/spec_helper.rb