magic_path 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60fc211126220aad9cfa38f5267ee8817c98d08e
+  data.tar.gz: b850dace2bf6c6f75dff819a654d3680ad43b495
+SHA512:
+  metadata.gz: 10da9388d49cedaafc28ce05c5ee10ae4f09996333ccd4b1efc30ffbf0bdbc5f363503194d5f4edc415f6368823557b40c0e4e7f2cc15b127a4c40c14c2186a8
+  data.tar.gz: 7ae953bbb7ba30a278ed75e97802d8793d891a77c524c0765ec947d0b17ccf4d6e73090495c6333f1fdab61644fd094dbe979b2a673c711c33e03b33417f58a7

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,9 @@
+Lint/Debugger:
+  Exclude:
+    - 'bin/console'
+
+Style/EndOfLine:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in magic_path.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    magic_path (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ast (2.3.0)
+    byebug (9.0.6)
+    coderay (1.1.1)
+    diff-lcs (1.3)
+    method_source (0.8.2)
+    nenv (0.3.0)
+    parallel (1.12.0)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.2)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.51.0)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    slop (3.6.0)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+  x86-mingw32
+
+DEPENDENCIES
+  bundler (~> 1.13)
+  magic_path!
+  nenv (~> 0.3)
+  pry (~> 0.10)
+  pry-byebug (~> 3.4)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   1.16.0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Donavan Stanley
+
+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,85 @@
+# magic_path
+A gem for dynamic file paths. Paths can be defined using strings with variable substitution.  i.e. 'fixtures/:product/:state".  When the path is resolved into a string any part that begins with a colon will be replaced with it's value from a params hash or resolver object.
+
+
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'magic_path'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install magic_path
+
+## Usage
+
+### Define a path and pass params to resolve
+```ruby
+# Create our path
+MagicPath.create_path :my_path, { pattern: 'data/:state/fixtures' }
+
+# use the path
+MagicPath.my_path.resolve { state: 'ohio' }
+# /data/ohio/fixtures
+```
+
+### Define a path using initial params
+```ruby
+# Create our path
+MagicPath.create_path :my_path, { pattern: 'data/:state/:product/fixtures', params: { product: 'foobar' } }
+
+# use the path
+MagicPath.my_path.resolve { state: 'ohio' }
+# /data/ohio/foobar/fixtures
+```
+
+### Define a path using other paths as variables
+```ruby
+## Create our base path
+MagicPath.create_path :base_data, { pattern: 'data/:state/:product', params: { product: 'foobar' } }
+# Create our path
+MagicPath.create_path :my_path, { pattern: ':base_data/fixtures' }
+
+# use the path
+MagicPath.my_path.resolve { state: 'ohio' }
+# /data/ohio/foobar/fixtures
+```
+
+### Define a path using environment variables (via Nenv)
+```ruby
+require 'Nenv' 
+
+# Create our path
+MagicPath.create_path :my_path, { pattern: 'data/:test_env/fixtures' }
+
+# use the path (Assuming test_env has been set to "test" in the environment)
+MagicPath.my_path.to_s # to_s is the same as calling resolve without an aditional params hash.
+# /data/test/fixtures
+```
+
+## Resolvers
+A resolver is a simply an object that can respond to a variable name.  You can create your own and add the to MagicPath like so:
+
+```ruby
+class MyResolver
+  def test_env
+    "test"
+  end
+end
+
+# Create our path
+MagicPath.create_path :my_path, { pattern: 'data/:test_env/fixtures' }
+MagicPath.add_resolver MyResolver.new
+MagicPath.my_path.to_s # to_s is the same as calling resolve without an aditional params hash.
+# /data/test/fixtures
+```
+
+If Nenv has already been required by your code, it will be automatically used as a resolver.  

data/Rakefile

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

data/bin/console

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'magic_path'
+
+# 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 'pry'
+# rubocop:disable Lint/Debugger
+binding.pry
+puts 'Obligatory line for pry.'
+# rubocop:enable Lint/Debugger

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/lib/magic_path/dynamic_path.rb

@@ -0,0 +1,81 @@
+# Root namespace for our gem
+module MagicPath
+  # A class to dynamically build paths based on parameters
+  # Constructed with a pattern like: /test_data/:product/:state/:env
+  # Each string beginning with a colon will be replaced from either
+  # the params hash passed to the initializer, the "extra_params" hash passed to resolve
+  # or environment variables (via Nenv).
+  # extra_params is merged into the instance level params hash before resolution
+  class DynamicPath
+    attr_accessor :params
+    attr_reader :pattern
+
+    def initialize(pattern, params = {})
+      @params = params || {}
+      @pattern = pattern
+      @locked_path = nil
+    end
+
+    def resolve(extra_params = {})
+      return @locked_path unless @locked_path.nil?
+      full_params = @params.merge(extra_params)
+      @pattern.split('/').map { |f| f[0] == ':' ? _var(f[1..-1], full_params) : f }.join('/')
+    end
+
+    def finalize(extra_params = {})
+      @locked_path = resolve(extra_params)
+    end
+
+    def finalized?
+      !@locked_path.nil?
+    end
+
+    def exist?(extra_params = {})
+      File.exist? resolve(extra_params)
+    end
+
+    def mkdir_p(extra_params = {})
+      FileUtils.mkdir_p resolve(extra_params)
+    end
+
+    def pathname(extra_params = {})
+      Pathname.new resolve(extra_params)
+    end
+
+    def join(filename, extra_params = {})
+      File.join(resolve(extra_params), filename)
+    end
+
+    def to_s(extra_params = {})
+      resolve extra_params
+    end
+
+    def to_str(extra_params = {})
+      to_s extra_params
+    end
+
+    def rmdir(extra_params = {})
+      Dir.rmdir resolve(extra_params)
+    end
+
+    def inspect
+      "DynamicPath: #{@pattern}"
+    end
+
+    private
+
+    def _var(var_name, full_params = {})
+      return full_params[var_name] if full_params.key?(var_name)
+      return full_params[var_name.to_sym] if full_params.key?(var_name.to_sym)
+
+      return MagicPath.send(var_name).resolve(full_params) if MagicPath.respond_to? var_name
+      resolver = _resolver_for(var_name)
+      return resolver.send(var_name) unless resolver.nil?
+      raise ArgumentError, "Could not locate #{var_name}, in params or resolvers."
+    end
+
+    def _resolver_for(var_name)
+      MagicPath.resolvers.find { |r| r.respond_to?(var_name) }
+    end
+  end
+end

data/lib/magic_path/path_manager.rb

@@ -0,0 +1,68 @@
+require 'magic_path/dynamic_path'
+
+module MagicPath
+  class PathManager
+    class Error < ArgumentError
+    end
+
+    class MethodError < Error
+      def initialize(meth)
+        @meth = meth
+      end
+    end
+
+    class AlreadyExistsError < MethodError
+      def message
+        format('Path %s already exists', @meth.inspect)
+      end
+    end
+
+    attr_writer :resolvers
+    def resolvers
+      @resolvers ||= default_resolvers
+    end
+
+    def default_resolvers
+      defined?(Nenv) ? [Nenv] : []
+    end
+
+    def add_resolver(resolver)
+      resolvers << resolver
+    end
+
+    def create_path(meth, opts)
+      self.class._create_path_accessor(singleton_class, meth)
+      send("#{meth}=", opts)
+    end
+
+    class << self
+      def create_path(meth, opts)
+        _create_path_accessor(self, meth, opts)
+        send("#{meth}=", opts)
+      end
+
+      def _create_path_accessor(klass, meth)
+        _fail_if_accessor_exists(klass, meth)
+        _create_path_writer(klass, meth)
+        _create_path_reader(klass, meth)
+      end
+
+      def _create_path_writer(klass, meth)
+        klass.send(:define_method, "#{meth}=") do |opts|
+          path = DynamicPath.new(opts[:pattern], opts[:params])
+          klass.class_variable_set("@@#{meth}".to_sym, path)
+        end
+      end
+
+      def _create_path_reader(klass, meth)
+        klass.send(:define_method, meth.to_s.delete('=')) do
+          klass.class_variable_get("@@#{meth}".to_sym)
+        end
+      end
+
+      def _fail_if_accessor_exists(klass, meth)
+        raise(AlreadyExistsError, meth) if klass.method_defined?(meth)
+      end
+    end
+  end
+end

data/lib/magic_path/version.rb

@@ -0,0 +1,3 @@
+module MagicPath
+  VERSION = '0.1.0'.freeze
+end

data/lib/magic_path.rb

@@ -0,0 +1,23 @@
+require 'magic_path/version'
+require 'magic_path/dynamic_path'
+# Root module for Magic Path
+require 'magic_path/path_manager'
+module MagicPath
+  class << self
+    def respond_to?(meth)
+      instance.respond_to?(meth)
+    end
+
+    def method_missing(meth, *args)
+      instance.send(meth, *args)
+    end
+
+    def reset
+      @instance = nil
+    end
+
+    def instance
+      @instance ||= MagicPath::PathManager.new
+    end
+  end
+end

data/magic_path.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'magic_path/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'magic_path'
+  spec.version       = MagicPath::VERSION
+  spec.authors       = ['Donavan Stanley']
+  spec.email         = ['donavan.stanley@gmail.com']
+
+  spec.summary       = 'A gem for managing dynamic path names.'
+  spec.homepage      = 'https://github.com/centric-automation/magic_path'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'pry-byebug', '~> 3.4'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'nenv', '~> 0.3'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: magic_path
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Donavan Stanley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: 
+email:
+- donavan.stanley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/magic_path.rb
+- lib/magic_path/dynamic_path.rb
+- lib/magic_path/path_manager.rb
+- lib/magic_path/version.rb
+- magic_path.gemspec
+homepage: https://github.com/centric-automation/magic_path
+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.6.13
+signing_key: 
+specification_version: 4
+summary: A gem for managing dynamic path names.
+test_files: []