alki-loader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35748f34edecf67d26bc0a7e3cf369c37a1316a6
+  data.tar.gz: c76640c73518c34797723b12cf3dc2fc0918fde5
+SHA512:
+  metadata.gz: 6d83c0157460cb42a860563d557a478476b3c6d3fa41001917cc9d8c7acdd529d6ea021affbacf0fdb4ea02ccd734e974016b697879f4eb3a827a4626f80b849
+  data.tar.gz: a813aea0fa6d21cc84dfc8cdeb6cc4cab609a8cd59f59d57adbf269b060879d06731334344993c24d8f51cac02a80fd1dffe1e99f711e229757863908b3ba6b8

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at matt.edlefsen@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Matt Edlefsen
+
+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.adoc

@@ -0,0 +1,124 @@
+# Alki::Loader
+
+Alki loader is a library for using "non-standard" source files in your project. What is
+a non-standard source file?
+
+Generally a ruby source file follows these rules:
+
+1. It should be placed in a directory that is in `$LOAD_PATH`, so that it can be loaded using `require`.
+2. It should define one ore more constants.
+3. Ideally, it should just define a constant that is the "classified" version of the relative path of the
+   file (if a directory `/project/lib` is in `$LOAD_DIR` and there is a file called `/project/lib/my_mod/my_class.rb`
+   then the constant defined within it should be `MyMod::MyClass`).
+
+This works well much of the time, but often enough it's nice to break some of these rules.
+For example, you might want files in directories in your project like `config` or `app` but don't want
+to add those to `$LOAD_PATH` because it could cause conflicts, or maybe you have files that you don't
+want to just define a module or class (like a DSL).
+
+Alki::Loader provides tools that enable these patterns while still allowing you to use these files
+in standard ways.
+
+There are three main components of Alki::Loader:
+
+Translater:: Allows registering directory and file paths with fake "names" so, for example, your
+         projects `config` directory could be registered with the name `my_project/config`. Now
+         when calling `require 'my_project/config/my_config'` Ruby will load `config/my_config.rb`
+         (but `require 'my_config'` will still find nothing).
+
+Builder:: Allows registering directory and file paths with "builder" objects and configuration values.
+          Files under these paths put their code in an unevaluated block that is passed to the builder
+          so that it can process it and ultimately define the expected constant for that path with
+          a value.
+
+Registry:: To allow the other two components to work, paths must be registered with Alki::Loader. This
+           can be done anytime in code but can also be set by putting register calls in an `alk_loader.rb`
+           file in any directory in `$LOAD_PATH`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alki-loader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install alki-loader
+
+## Usage
+
+```ruby
+require 'alki/loader'
+```
+
+Once the library is required you can require files as you normally would.
+
+To register a path, use `Alki::Loader.register(path,settings)`. This can be called anywhere at any
+time, but to make sure your paths are registered before they're needed, it's best to use an
+`alki_loader.rb` file.
+
+To use one create a `alki_loader.rb` file in whatever directory in your project is in `$LOAD_PATH`
+(typically `lib`). It should just contain normal `Alki::Loader.register` calls.
+
+The path argument to register should either be an absolute path, or a path relative to directory of the
+calling file (if you have `Alki::Loader.register '../config', ... ` in `lib/alki_loader.rb` it will
+register `config`).
+
+If path registrations exist for multiple prefixes of the same file, the longest one will be used.
+
+### Settings
+
+When registering a path, the second argument is hash of settings to configure the path. These can be
+arbitrary key/value pairs but there are two setting values with special meaning.
+
+[horizontal]
+name:: Provide a name for the translater to use for this path. Will translate just the registered
+       path and leave the rest of the path the same when changed.
+builder:: Set the builder object, if one is wanted. Can be any object with a `build` method or a require
+          path where a constant can be found that has a build class method (`my_project/my_builder` will
+          attempt to find `MyProject::MyBuilder` and will call `require 'my_project/my_builder'`
+          to try and find it).
+
+### Builders
+
+A file that is to be built using a builder should always be in an Alki block:
+
+.my_file.rb
+```ruby
+Alki do
+  # stuff goes here
+end
+```
+
+When the file is loaded, the builder object registered for the path will be called like so:
+
+```ruby
+builder.build settings, &blk
+```
+
+Where `blk` is the unevaluated block from the file, and `settings` is a hash containing all of the
+settings registered to the path, along with two extra settings so the builder knows what file it's
+building.
+
+[horizontal]
+name:: What would be passed to `require` to load the file. If the file is in a `$LOAD_PATH` directory
+       it will be the relative path from the directory minus the '.rb'. If there is name translation
+       registered on the path, that will be used instead.
+constant_name:: The "class-ified" version of the name, following the typical rules for translating
+                require paths into constant names. No special rules are used for abbreviations.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alki-project/alki-loader. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the http://contributor-covenant.org[Contributor Covenant] code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the http://opensource.org/licenses/MIT[MIT License].
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/alki-loader.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alki/loader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "alki-loader"
+  spec.version       = Alki::Loader::VERSION
+  spec.authors       = ["Matt Edlefsen"]
+  spec.email         = ["matt.edlefsen@gmail.com"]
+
+  spec.summary       = %q{Library for loading non-traditional ruby files}
+  spec.homepage      = "https://github.com/alki-project/alki-loader"
+  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 "minitest", "~> 5.9"
+  spec.add_dependency "alki-support", "~> 0.7"
+end

data/lib/alki/loader.rb

@@ -0,0 +1,67 @@
+require 'alki/support'
+require 'alki/loader/registry'
+require 'alki/loader/entry'
+require 'alki/loader/core_ext/kernel'
+
+module Alki
+  module Loader
+    LoaderError = Class.new(StandardError)
+
+    @registry = Alki::Loader::Registry.new
+
+    def self.registered_paths
+      @registry.paths
+    end
+
+    def self.translate(name)
+      entry = @registry.lookup_name(name)
+      if entry
+        entry.path + name[entry.name.size..-1]
+      end
+    end
+
+    def self.lookup_name(path)
+      path_name @registry.lookup_path(path), path
+    end
+
+    def self.build(path,builder=nil,data=nil,&blk)
+      entry = @registry.lookup_path(path)
+      unless entry
+        raise LoaderError.new("No path registered for #{path}")
+      end
+      builder ||= entry.data[:builder]
+      unless builder
+        raise LoaderError.new("No builder registered for #{path}")
+      end
+      name = path_name(entry, path) or
+        raise LoaderError.new("Path not registered with name or in $LOAD_PATH #{path}")
+      data ||= entry.data
+      builder = Alki::Support.load builder
+      builder.build data.merge(name: name, constant_name: Alki::Support.classify(name)), &blk
+    end
+
+    def self.register(path,**data)
+      unless path.start_with? '/'
+        caller_dir = File.dirname(caller_locations(1,1)[0].absolute_path)
+        path = File.expand_path(path,caller_dir)
+      end
+      @registry.add Entry.new(path,data)
+    end
+
+    private
+
+    def self.path_name(entry,path)
+      if entry && entry.name
+        name = entry.name + path[entry.path.size..-1]
+      else
+        dir = $LOAD_PATH.find{|d| path.start_with?(File.join(d,''))}
+        unless dir
+          return nil
+        end
+        name = path[File.join(dir,'').size..-1]
+      end
+      name.chomp!('.rb')
+      name
+    end
+  end
+end

data/lib/alki/loader/core_ext/kernel.rb

@@ -0,0 +1,24 @@
+require 'alki/loader'
+
+module Kernel
+  alias_method :__alki_loader_original_require, :require
+
+  def require(name)
+    __alki_loader_original_require name
+  rescue LoadError => e
+    translated = Alki::Loader.translate(name)
+    if translated
+      __alki_loader_original_require translated
+    else
+      raise e
+    end
+  end
+
+  def Alki(builder=nil,data=nil,&blk)
+    if blk
+      path = caller_locations(1,1)[0].absolute_path
+      Alki::Loader.build path, builder, data, &blk
+    end
+    ::Alki
+  end
+end

data/lib/alki/loader/entry.rb

@@ -0,0 +1,21 @@
+module Alki
+  module Loader
+    class Entry
+      attr_reader :path
+      attr_reader :data
+
+      def initialize(path,data)
+        @path = path.chomp('/')
+        @data = data
+      end
+
+      def name
+        @data[:name]
+      end
+
+      def build(blk)
+        Alki::Support.load_class(@builder).build @data, &blk
+      end
+    end
+  end
+end

data/lib/alki/loader/registry.rb

@@ -0,0 +1,64 @@
+module Alki
+  module Loader
+    class Registry
+      def initialize
+        clear
+      end
+
+      def clear
+        @paths = []
+        @paths_sorted = true
+        @names = []
+        @names_sorted = true
+        @configs_loaded = false
+      end
+
+      def paths
+        load_configs!
+        @paths.map{|e| e.path }
+      end
+
+      def add(entry)
+        @paths.delete_if{|e| e.path == entry.path }
+        @paths << entry
+        if entry.name
+          @names.delete_if{|e| e.path == entry.path }
+          @names << entry
+        end
+      end
+
+      def lookup_name(name)
+        load_configs!
+        unless @names_sorted
+          @names.sort! {|a,b| b.name <=> a.name }
+          @names_sorted = true
+        end
+        @names.find do |e|
+          name.start_with?(e.name) &&
+            (name.size == e.name.size || name[e.name.size] == '/')
+        end
+      end
+
+      def lookup_path(path)
+        load_configs!
+        unless @paths_sorted
+          @paths.sort! {|a,b| b.path <=> a.path }
+          @paths_sorted = true
+        end
+        @paths.find do |e|
+          path.start_with?(e.path) &&
+            (path.size == e.path.size || path[e.path.size] == '/')
+        end
+      end
+
+      def load_configs!
+        path_hash = $LOAD_PATH.hash
+        return if @configs_loaded == path_hash
+        @configs_loaded = path_hash
+        Gem.find_files_from_load_path('alki_loader.rb').each do |config_path|
+           require config_path
+        end
+      end
+    end
+  end
+end

data/lib/alki/loader/version.rb

@@ -0,0 +1,5 @@
+module Alki
+  module Loader
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: alki-loader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Edlefsen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-29 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+- !ruby/object:Gem::Dependency
+  name: alki-support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: 
+email:
+- matt.edlefsen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.adoc
+- Rakefile
+- alki-loader.gemspec
+- lib/alki/loader.rb
+- lib/alki/loader/core_ext/kernel.rb
+- lib/alki/loader/entry.rb
+- lib/alki/loader/registry.rb
+- lib/alki/loader/version.rb
+homepage: https://github.com/alki-project/alki-loader
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Library for loading non-traditional ruby files
+test_files: []