dry-core 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f18461caed54954ed1ded7991e22481fb2460f54
+  data.tar.gz: 6f14a3398ad397e64db754967b4315a440b225f1
+SHA512:
+  metadata.gz: b68b62a1b7bceb698b669c9462c4bfded77dd1536dbcaaa201c76c34414df3d28e85042e106d2809ad118caabbd8ce84a4e5d09da835cf03dfa7f1f53ea7cda7
+  data.tar.gz: 0960b20d7483027f61502c64c0c06d69f37bca79c90f6bc4aedc190328bf9d354ca323c17e34a28a281f9cf27b59b6acd6c51fb0d7f36089fb1665d9103257e2

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+spec/examples.txt

data/.inch.yml

@@ -0,0 +1,4 @@
+files:
+  excluded:
+    - lib/dry/core.rb
+    - lib/dry/core/version.rb

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require ./spec/spec_helper.rb

data/.rubocop.yml

@@ -0,0 +1,31 @@
+AllCops:
+  TargetRubyVersion: 2.1
+  Exclude:
+    - 'dry-core.gemspec'
+    - 'spec/spec_helper.rb'
+
+Style/SignalException:
+  Exclude:
+    - 'spec/**/*'
+
+Style/RedundantSelf:
+  Exclude:
+    - 'lib/dry/core/deprecations.rb'
+
+Metrics/LineLength:
+  Max: 110
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/FileName:
+  Exclude:
+    - 'lib/dry-core.rb'
+
+Lint/AmbiguousRegexpLiteral:
+  Exclude:
+    - 'spec/**/*'
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,28 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.9
+  - 2.2.5
+  - 2.3.1
+  - rbx-2
+  - jruby-9.1.4.0
+  - ruby-head
+
+before_install: gem update bundler
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+notifications:
+  email:
+    recipients:
+      - fg@flashgordon.ru
+    on_success: change
+    on_failure: always
+    on_start: false     # default: false
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/19098b4253a72c9796db
+    on_success: change  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: false     # default: false
+

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter', require: false
+  gem 'simplecov', require: false
+end
+
+group :tools do
+  gem 'byebug', platform: :mri
+  gem 'rubocop'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nikita Shilnikov
+
+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,47 @@
+[gitter]: https://gitter.im/dry-rb/chat
+[gem]: https://rubygems.org/gems/dry-core
+[travis]: https://travis-ci.org/dry-rb/dry-core
+[code_climate]: https://codeclimate.com/github/dry-rb/dry-core
+[inch]: http://inch-ci.org/github/dry-rb/dry-core
+
+# dry-core
+
+[![Gem Version](https://img.shields.io/gem/v/dry-core.svg)][gem]
+[![Build Status](https://img.shields.io/travis/dry-rb/dry-core.svg)][travis]
+[![Code Climate](https://img.shields.io/codeclimate/github/dry-rb/dry-core.svg)][code_climate]
+[![Test Coverage](https://img.shields.io/codeclimate/coverage/github/dry-rb/dry-core.svg)][code_climate]
+[![API Documentation Coverage](http://inch-ci.org/github/dry-rb/dry-core.svg)][inch]
+![No monkey-patches](https://img.shields.io/badge/monkey--patches-0-brightgreen.svg)
+
+A collection of small modules used in the dry-rb ecosystem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dry-core'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dry-core
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/dry-rb/dry-core.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/dry-core.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dry/core/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dry-core'
+  spec.version       = Dry::Core::VERSION
+  spec.authors       = ['Nikita Shilnikov']
+  spec.email         = ['fg@flashgordon.ru']
+
+  spec.summary       = 'A toolset of small support modules used throughout the dry-rb ecosystem.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/dry-rb/dry-code'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|bin)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/dry-core.rb

@@ -0,0 +1 @@
+require 'dry-core'

data/lib/dry/core.rb

@@ -0,0 +1,8 @@
+require 'dry/core/version'
+
+# :nodoc:
+module Dry
+  # :nodoc:
+  module Core
+  end
+end

data/lib/dry/core/cache.rb

@@ -0,0 +1,66 @@
+require 'concurrent/map'
+
+module Dry
+  module Core
+    # Allows you to cache call results that are solely determined by arguments.
+    #
+    # @example
+    #   require 'dry/core/cache'
+    #
+    #   class Foo
+    #     extend Dry::Core::Cache
+    #
+    #     def heavy_computation(arg1, arg2)
+    #       fetch_or_store(arg1, arg2) { arg1 ^ arg2 }
+    #     end
+    #   end
+    #
+    # @api public
+    module Cache
+      # @api private
+      def self.extended(klass)
+        super
+        klass.include(Methods)
+        klass.instance_variable_set(:@__cache__, Concurrent::Map.new)
+      end
+
+      # @api private
+      def inherited(klass)
+        super
+        klass.instance_variable_set(:@__cache__, cache)
+      end
+
+      # @api private
+      def cache
+        @__cache__
+      end
+
+      # Caches a result of the block evaluation
+      #
+      # @param [Array<Object>] args List of hashable objects
+      # @yield An arbitrary block
+      #
+      # @note beware Proc instance hashes are not equal, i.e. -> { 1 }.hash != -> { 1 }.hash,
+      #       this means you shouldn't pass Procs in args unless you're sure
+      #       they are always the same instances, otherwise you introduce a memory leak
+      #
+      # @return [Object] block's return value (cached for subsequent calls with the same argument values)
+      def fetch_or_store(*args, &block)
+        cache.fetch_or_store(args.hash, &block)
+      end
+
+      # Instance methods
+      module Methods
+        # Delegates call to the class-level method
+        #
+        # @param [Array<Object>] args List of hashable objects
+        # @yield An arbitrary block
+        #
+        # @return [Object] block's return value
+        def fetch_or_store(*args, &block)
+          self.class.fetch_or_store(*args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/dry/core/class_builder.rb

@@ -0,0 +1,38 @@
+module Dry
+  module Core
+    # Class for generating more classes
+    class ClassBuilder
+      attr_reader :name
+      attr_reader :parent
+
+      def initialize(name:, parent: Object)
+        @name = name
+        @parent = parent
+      end
+
+      # Generate a class based on options
+      #
+      # @example
+      #   builder = Dry::Core::ClassBuilder.new(name: 'MyClass')
+      #
+      #   klass = builder.call
+      #   klass.name # => "MyClass"
+      #
+      # @return [Class]
+      def call
+        klass = Class.new(parent)
+        name = self.name
+
+        klass.singleton_class.class_eval do
+          define_method(:name) { name }
+          alias_method :inspect, :name
+          alias_method :to_s, :name
+        end
+
+        yield(klass) if block_given?
+
+        klass
+      end
+    end
+  end
+end

data/lib/dry/core/constants.rb

@@ -0,0 +1,49 @@
+require 'set'
+
+module Dry
+  module Core
+    # A list of constants you can use to avoid memory allocations or identity checks.
+    #
+    # @example Just include this module to your class or module
+    #   class Foo
+    #     def call(value = EMPTY_ARRAY)
+    #        value.map(&:to_s)
+    #     end
+    #   end
+    #
+    # @api public
+    module Constants
+      # An empty array
+      EMPTY_ARRAY = [].freeze
+      # An empty hash
+      EMPTY_HASH = {}.freeze
+      # An empty list of options
+      EMPTY_OPTS = {}.freeze
+      # An empty set
+      EMPTY_SET = Set.new.freeze
+      # An empty string
+      EMPTY_STRING = ''.freeze
+
+      # A special value you can use as a default to know if no arguments
+      # were passed to you method
+      #
+      # @example
+      #   def method(value = Undefined)
+      #     if value == Undefined
+      #       puts 'no args'
+      #     else
+      #       puts value
+      #     end
+      #   end
+      Undefined = Object.new.tap do |undefined|
+        def undefined.to_s
+          'Undefined'
+        end
+
+        def undefined.inspect
+          'Undefined'
+        end
+      end.freeze
+    end
+  end
+end

data/lib/dry/core/deprecations.rb

@@ -0,0 +1,157 @@
+require 'logger'
+
+module Dry
+  module Core
+    # An extension for issueing warnings on using deprecated methods.
+    #
+    # @example
+    #
+    #   class Foo
+    #     def self.old_class_api; end
+    #     def self.new_class_api; end
+    #
+    #     deprecate_class_method :old_class_api, :new_class_api
+    #
+    #     def old_api; end
+    #     def new_api; end
+    #
+    #     deprecate_method :old_api, :new_api, "old_api is no-no"
+    #   end
+    #
+    # @example You also can use this module for your custom messages
+    #
+    #   Dry::Core::Deprecations.announce("Foo", "use bar instead")
+    #   Dry::Core::Deprecations.warn("Baz is going to be removed soon")
+    #
+    # @api public
+    module Deprecations
+      class << self
+        # Prints a warning
+        #
+        # @param [String] msg Warning string
+        def warn(msg)
+          logger.warn(msg.gsub(/^\s+/, ''))
+        end
+
+        # Wraps arguments with a standard message format and prints a warning
+        #
+        # @param [Object] name what is deprecated
+        # @param [String] msg additional message usually containing upgrade instructions
+        def announce(name, msg)
+          warn(deprecation_message(name, msg))
+        end
+
+        # @api private
+        def deprecation_message(name, msg)
+          <<-MSG
+            #{name} is deprecated and will be removed in the next major version
+            #{message(msg)}
+          MSG
+        end
+
+        # @api private
+        def deprecated_method_message(old, new = nil, msg = nil)
+          if new
+            deprecation_message(old, <<-MSG)
+              Please use #{new} instead.
+              #{msg}
+            MSG
+          else
+            deprecation_message(old, msg)
+          end
+        end
+
+        # @api private
+        def message(msg)
+          <<-MSG
+            #{msg}
+            #{caller.detect { |l| l !~ %r{(lib/dry/core)|(gems)} }}
+          MSG
+        end
+
+        # Returns the logger used for printing warnings.
+        # You can provide your own with .set_logger!
+        #
+        # @param [String, Symbol] tag optional prefix for messages
+        # @param [IO] output output stream
+        #
+        # @return [Logger]
+        def logger(tag = nil, output = nil)
+          if defined?(@logger)
+            @logger
+          else
+            set_logger!(output: output, tag: tag)
+          end
+        end
+
+        # Sets a custom logger. This is a global settings.
+        #
+        # @option [IO] output output stream for messages
+        # @option [String, Symbol] tag optional prefix
+        #
+        # TODO: Add support for per-module loggers so that at least
+        #       tag option won't conflict.
+        def set_logger!(output: nil, tag: nil)
+          @logger = Logger.new(output || $stdout)
+          @logger.formatter = proc { |_severity, _datetime, _progname, msg|
+            "[#{tag || 'deprecated'}] #{msg}\n"
+          }
+          @logger
+        end
+      end
+
+      # Mark instance method as deprecated
+      #
+      # @param [Symbol] old_name deprecated method
+      # @param [Symbol] new_name replacement (not required)
+      # @option [String] message optional deprecation message
+      def deprecate(old_name, new_name = nil, message: nil)
+        full_msg = Deprecations.deprecated_method_message(
+          "#{self.name}##{old_name}",
+          new_name ? "#{self.name}##{new_name}" : nil,
+          message
+        )
+
+        if new_name
+          undef_method old_name
+          define_method(old_name) do |*args, &block|
+            Deprecations.warn(full_msg)
+            __send__(new_name, *args, &block)
+          end
+        else
+          aliased_name = :"#{old_name}_without_deprecation"
+          alias_method aliased_name, old_name
+          private aliased_name
+          undef_method old_name
+          define_method(old_name) do |*args, &block|
+            Deprecations.warn(full_msg)
+            __send__(aliased_name, *args, &block)
+          end
+        end
+      end
+
+      # Mark class-level method as deprecated
+      #
+      # @param [Symbol] old_name deprecated method
+      # @param [Symbol] new_name replacement (not required)
+      # @option [String] message optional deprecation message
+      def deprecate_class_method(old_name, new_name = nil, message: nil)
+        full_msg = Deprecations.deprecated_method_message(
+          "#{self.name}.#{old_name}",
+          new_name ? "#{self.name}.#{new_name}" : nil,
+          message
+        )
+
+        meth = new_name ? method(new_name) : method(old_name)
+
+        singleton_class.instance_exec do
+          undef_method old_name
+          define_method(old_name) do |*args, &block|
+            Deprecations.warn(full_msg)
+            meth.call(*args, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/core/extensions.rb

@@ -0,0 +1,53 @@
+require 'set'
+
+module Dry
+  module Core
+    # Allows to define extensions that can be later enabled by the user.
+    #
+    # @example
+    #
+    #   class Foo
+    #     extend Dry::Core::Extensions
+    #
+    #     register_extension(:bar) do
+    #        def bar; :bar end
+    #     end
+    #   end
+    #
+    #   Foo.new.bar # => NoMethodError
+    #   Foo.load_extensions(:bar)
+    #   Foo.new.bar # => :bar
+    #
+    module Extensions
+      # @api private
+      def self.extended(obj)
+        super
+        obj.instance_variable_set(:@__available_extensions__, {})
+        obj.instance_variable_set(:@__loaded_extensions__, Set.new)
+      end
+
+      # Register an extension
+      #
+      # @param [Symbol] name extension name
+      # @yield extension block. This block guaranteed not to be called more than once
+      def register_extension(name, &block)
+        @__available_extensions__[name] = block
+      end
+
+      # Enables specified extensions. Already enabled extensions remain untouched
+      #
+      # @param [Array<Symbol>] extensions list of extension names
+      def load_extensions(*extensions)
+        extensions.each do |ext|
+          block = @__available_extensions__.fetch(ext) do
+            raise ArgumentError, "Unknown extension: #{ext.inspect}"
+          end
+          unless @__loaded_extensions__.include?(ext)
+            block.call
+            @__loaded_extensions__ << ext
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/core/version.rb

@@ -0,0 +1,5 @@
+module Dry
+  module Core
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: dry-core
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nikita Shilnikov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-17 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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A toolset of small support modules used throughout the dry-rb ecosystem.
+email:
+- fg@flashgordon.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".inch.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dry-core.gemspec
+- lib/dry-core.rb
+- lib/dry/core.rb
+- lib/dry/core/cache.rb
+- lib/dry/core/class_builder.rb
+- lib/dry/core/constants.rb
+- lib/dry/core/deprecations.rb
+- lib/dry/core/extensions.rb
+- lib/dry/core/version.rb
+homepage: https://github.com/dry-rb/dry-code
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A toolset of small support modules used throughout the dry-rb ecosystem.
+test_files: []