context_provider 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4312544e6eaeec3ef290c59ca1953364e610a6f0d063d0d3cdd881b303b90326
+  data.tar.gz: '0808b0d8c3061208467a56f239054e080293dd4fb8ff9e35b03f9d9f5b581b40'
+SHA512:
+  metadata.gz: 051c19bc1721fd6193435fec645f0333b7836fd8f35c58b5c18c0df6e5ffcd6c293d311a3d83a38cfa93a8f03a35feb08359cb8df60210f12da356d5032ce3a8
+  data.tar.gz: 8f88e600ffac354307c422671ab75dcc035b1cc2d22627979860f0f7fbb9a5770b227a1e2895e2a99bd010b2f155827f9e59d601d5ac370b6ca5e229c1ee2539

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem
+
+TODO.md

data/.rubocop.yml

@@ -0,0 +1,16 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+AllCops:
+  NewCops: enable
+
+Metrics/BlockLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [ZeroVer](https://0ver.org/).
+
+## [Unreleased]
+
+
+## [0.0.1] - 2021-03-21
+### Added
+- `ContextProvider`
+- README
+
+
+[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
+[0.0.1]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/v0.0.1

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in context_provider.gemspec
+gemspec
+
+gem 'minitest', '~> 5.0'
+gem 'pry', '~> 0.13.1'
+gem 'rake', '~> 12.0'
+gem 'rubocop', '~> 1.11', require: false
+gem 'rubocop-minitest', require: false
+gem 'rubocop-rake', require: false

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    context_provider (0.0.1)
+      concurrent-ruby (>= 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rubocop (1.11.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-minitest (0.10.3)
+      rubocop (>= 0.87, < 2.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  context_provider!
+  minitest (~> 5.0)
+  pry (~> 0.13.1)
+  rake (~> 12.0)
+  rubocop (~> 1.11)
+  rubocop-minitest
+  rubocop-rake
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Vinicius Tabille Manjabosco
+
+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,68 @@
+# ContextProvider
+
+This is the Ruby version of the context pattern originally outlined in 
+[React](https://reactjs.org/docs/context.html). 
+
+The context patter is a solution for a problem that in React is called prop 
+drilling.
+
+We have found this pattern to be quite useful for Rails applications. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'context_provider'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install contextprovider
+
+## Usage
+
+A `ContextProvider` allows data to be passed down the call stack in a explicit
+way while avoiding having to pass parameters just so it can be used by a nested
+function.
+
+```ruby
+fooContext = ContextProvider.new
+
+fooContext.value_provided? #=> false
+fooContext.get # raises ContextNotProvidedError
+
+fooContext.provide("bar") do
+  if fooContext.value_provided? #=> true
+    fooContext.get #=> "bar"
+  end
+  
+  fooContext.provide("baz") do # raise ContextAlreadyProvidedError
+    # ...
+  end
+  
+  fooContext.where_provide_was_called #=> `provide` caller call stack
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run 
+`rake test` to run the tests. You can also run `bin/console` for an 
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run 
+`bundle exec rake install`. To release a new version, update the version 
+number in `version.rb`, and then run `bundle exec rake release`, which 
+will create a git tag for the version, push git commits and tags, and 
+push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at 
+https://github.com/thevtm/contextprovider.
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'context_provider'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/contextprovider.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/context_provider/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'context_provider'
+  spec.version       = ContextProvider::VERSION
+  spec.licenses      = ['MIT']
+  spec.authors       = ['Vinicius Manjabosco']
+  spec.email         = ['vinicius.manjabosco@lendahand.com']
+
+  spec.summary       = 'Ruby version of the context pattern from React.'
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = 'https://github.com/thevtm/context_provider'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/thevtm/contextprovider/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'concurrent-ruby', '~> 1.0'
+end

data/lib/context_provider.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'concurrent-ruby'
+
+require 'context_provider/version'
+
+# A +ContextProvider+ allows data to be passed down the call stack in a explicit
+# way while avoiding having to pass parameters just so it can be used by a
+# nested function.
+#
+# @example
+#   context = ContextProvider.new
+#
+#   context.provide("bar") do
+#     context.get #=> "bar"
+#   end
+class ContextProvider
+  class Error < StandardError; end
+
+  class ContextAlreadyProvidedError < Error; end
+
+  class ContextNotProvidedError < Error; end
+
+  def initialize
+    @provided = Concurrent::ThreadLocalVar.new
+    @provide_call_stack = Concurrent::ThreadLocalVar.new
+  end
+
+  # Provided value that can be accessed using +get+ inside the nested block.
+  #
+  # @raise [ContextAlreadyDefinedError] if context has already been provide
+  #
+  # @param [Object] value Value to be passed down the stack
+  # @param [Proc] block Block where provided value is going to be available.
+  def provide(value, &block)
+    if value_provided?
+      raise ContextAlreadyProvidedError,
+            'Failed to provide context because it has already been provided!'
+    end
+
+    begin
+      set_provided_value(value)
+      block.call
+    ensure
+      unset_provided_value
+    end
+  end
+
+  # Gets value from provided by the context.
+  #
+  # @raises [ContextNotProvidedError] if no value has been provided
+  #
+  # @return [Object] provided value
+  def get
+    unless value_provided?
+      raise ContextNotProvidedError,
+            'Unable to get context value as it has not been defined!'
+    end
+
+    @provided.value
+  end
+
+  # Returns +true+ when value has been provided (inside a +provide+ block)
+  # +false+ otherwise.
+  #
+  # @return [Boolean]
+  def value_provided?
+    @provide_call_stack.value != nil
+  end
+
+  # Returns the callstack for where +provide+ was called.
+  #
+  # @raise [ContextNotProvidedError] if no value has been provided
+  #
+  # @return [Array] callstack for where +provide+ was called
+  def where_provide_was_called
+    unless value_provided?
+      raise ContextNotProvidedError,
+            'Unable to get the provide callstack because context has not been ' \
+            'provided!'
+    end
+
+    @provide_call_stack.value
+  end
+
+  # Sets provided value.
+  # Doesn't perform any checks.
+  # Doesn't clean up (see +dangerously_unset_provided_value+).
+  # Should only be used as a last resort.
+  #
+  # @param [Object] value
+  def dangerously_set_provided_value(value)
+    set_provided_value(value)
+  end
+
+  # Unsets provided value.
+  # Doesn't perform any checks.
+  # Meant to be used in conjunction with +dangerously_set_provided_value+.
+  # Should only be used as a last resort.
+  def dangerously_unset_provided_value
+    unset_provided_value
+  end
+
+  private
+
+  # rubocop:disable Naming/AccessorMethodName
+  def set_provided_value(value)
+    @provide_call_stack.value = caller(2)
+    @provided.value = value
+  end
+  # rubocop:enable Naming/AccessorMethodName
+
+  def unset_provided_value
+    @provided.value = nil
+    @provide_call_stack.value = nil
+  end
+end

data/lib/context_provider/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ContextProvider
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: context_provider
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vinicius Manjabosco
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description:
+email:
+- vinicius.manjabosco@lendahand.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- contextprovider.gemspec
+- lib/context_provider.rb
+- lib/context_provider/version.rb
+homepage: https://github.com/thevtm/context_provider
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/thevtm/context_provider
+  source_code_uri: https://github.com/thevtm/context_provider
+  changelog_uri: https://github.com/thevtm/contextprovider/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Ruby version of the context pattern from React.
+test_files: []