require_module 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8de7ec307473e3260046abee12619a9b4239b406dffd7cb7680c5c44852e4c4f
+  data.tar.gz: 397cc6e76d6463b7395ae604acaebaf6e21c9ea8fdcff31a691fce13ac9a0892
+SHA512:
+  metadata.gz: '019281db025c320f5c98a143549ba6c034276ab8a94e8166d597128620821056305e0c9474f64a42459f6718fbeebfee541d13657a6dae5ef322befb70697a0d'
+  data.tar.gz: 328e26a5698c513c00f5d3fca278f7c53dca358f1697f2d3e738dc00aa06aaa2b95a3945f19a979794c44d3c5f70c9edbffd163cda35fd34e815bdd76459de56

data/.gitignore

@@ -0,0 +1,6 @@
+pkg
+coverage/
+.ruby-version
+.ruby-gemset
+.rspec
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,16 @@
+rvm:
+ - 2.4.0
+ - 2.3.3
+ - 2.2.6
+ - jruby-19mode
+ - rbx-3
+ - ruby-head
+notifications:
+  recipients:
+    - melgaardbjorn@gmail.com
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-19mode
+    - rvm: rbx-3
+

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'coveralls', require: false
+gem 'pry', require: false

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jarmo Pertman
+
+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,75 @@
+# require_module
+
+[![Build Status](https://travis-ci.org/BjornMelgaard/require_module.svg?branch=master)](https://travis-ci.org/BjornMelgaard/require_module)
+
+Evaluates file content inside Module.new, with cache
+
+# API
+
+## require_module(fullpath)
+
+Evaluates file content inside Module.new and returns new module
+
+```rb
+require_module('/home/user/rubyapp/lib', cache: false) # returns #<Module:0000012312>
+require_module('/home/user/rubyapp/lib') # returns :HomeUserRubyappLib
+```
+
+## require_module_relative(relative_path)
+
+Similar to "require_module", but path is relative to file, where function is executed
+
+Check `lib/require_module.rb` for more
+
+
+# Example
+If you don't want you modules to intersect, they should have unique name.
+I was tired of coming up with new names, so created this gem.
+
+Instead of
+
+```rb
+# lib.rb
+module GloballyUniqueName
+  module_function
+
+  def somefn
+    'Ima helper'
+  end
+end
+```
+
+```rb
+# consumer.rb
+require_relative './lib'
+
+module Consumer
+  include GloballyUniqueName
+
+  def foo
+    somefn == 'Ima helper'
+  end
+end
+```
+
+You can write this
+
+```rb
+# lib.rb
+module_function
+
+def somefn
+  'Ima helper'
+end
+```
+
+```rb
+# consumer.rb
+module Consumer
+  include require_module_relative('./lib')
+
+  def foo
+    somefn == 'Ima helper'
+  end
+end
+```

data/Rakefile

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

data/lib/require_module.rb

@@ -0,0 +1,87 @@
+module RequireModule
+  # Evaluates file content inside Module.new and returns new module
+  #
+  # ==== Attributes
+  #
+  # * +fullpath+ - Absolute path to .rb file, .rb extension is optional
+  #
+  # ==== Options
+  #
+  # * +:cache+ - Default - true.
+  # If false - creates new Module object with unique name.
+  # If true - creates new or returns already created Module with name, based on path to file
+  #
+  # ==== Examples
+  #
+  #    require_module('/home/user/rubyapp/lib', cache: false) # returns #<Module:0000012312>
+  #    require_module('/home/user/rubyapp/lib') # returns :HomeUserRubyappLib
+  def require_module(fullpath, cache: true)
+    with_ext    = add_ext(fullpath)
+    without_ext = rem_ext(fullpath)
+
+    if cache
+      constant_name =
+        without_ext
+        .split(/[^a-zA-Z]/)
+        .map(&:capitalize)
+        .join
+        .to_sym
+
+      begin
+        Object.const_get(constant_name)
+      rescue NameError
+        mod = gen_mod(with_ext)
+        Object.const_set(constant_name, mod)
+        mod
+      end
+    else
+      gen_mod(with_ext)
+    end
+  end
+
+  # Similar to "require_module", but path is relative to file, where function is executed
+  #
+  # ==== Attributes
+  #
+  # * +path+ - Relative path to .rb file, .rb extension is optional
+  #
+  # ==== Options
+  #
+  # * +:cache+ - Default - true.
+  # If false - creates new Module object with unique name.
+  # If true - creates new or returns already created Module with name, based on path to file
+  def require_module_relative(path, **options)
+    caller_filepath = caller_locations(1..1).first.absolute_path
+    caller_dir = File.dirname(caller_filepath)
+
+    fullpath = File.expand_path(path, caller_dir)
+
+    require_module(fullpath, **options)
+  end
+
+  private
+
+  def gen_mod(fullpath)
+    content = read_rb(fullpath)
+
+    Module.new.tap do |mod|
+      mod.module_eval(content, fullpath, 1)
+    end
+  end
+
+  def read_rb(fullpath)
+    File.read(fullpath)
+  rescue Errno::ENOENT
+    raise LoadError, "path doesn't exist at #{fullpath}"
+  end
+
+  def add_ext(path)
+    Pathname.new(path).sub_ext('.rb').to_s
+  end
+
+  def rem_ext(path)
+    path.sub(/#{File.extname(path)}$/, '')
+  end
+end
+
+include RequireModule

data/require_module.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name    = 'require_module'
+  s.version = '0.0.1'
+  s.authors = ['Sergey Homa']
+  s.email   = 'melgaardbjorn@gmail.com'
+  s.summary = 'Evaluates file content inside Module.new, with cache'
+
+  s.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.homepage = 'https://github.com/BjornMelgaard/require_module'
+  s.license  = 'MIT'
+
+  s.has_rdoc         = true
+  s.rdoc_options     = %w[--title require_all --main README.md --line-numbers]
+  s.extra_rdoc_files = ['LICENSE', 'README.md']
+end

data/spec/fixtures/some_lib.rb

@@ -0,0 +1,5 @@
+module_function
+
+def some_fn
+  'some_val'
+end

data/spec/require_module_spec.rb

@@ -0,0 +1,57 @@
+require_relative 'spec_helper'
+
+def unload_all_matching(regex)
+  Object.constants.grep(regex).each do |const|
+    Object.send(:remove_const, const)
+  end
+end
+
+describe 'require_module_relative' do
+  before do
+    unload_all_matching(/FixturesSomeLib/)
+  end
+
+  it 'without ext' do
+    mod = require_module_relative './fixtures/some_lib'
+
+    expect(mod.inspect).to end_with 'FixturesSomeLib'
+    expect(mod.some_fn).to eq 'some_val'
+  end
+
+  it 'with ext' do
+    mod = require_module_relative './fixtures/some_lib.rb'
+
+    expect(mod.inspect).to end_with 'FixturesSomeLib'
+    expect(mod.some_fn).to eq 'some_val'
+  end
+
+  it "raises NameError if dependencies can't be resolved" do
+    expect do
+      require_module_relative './unresolveable'
+    end.to raise_error(LoadError)
+  end
+
+  it 'test cache' do
+    mod = require_module_relative './fixtures/some_lib'
+    mod2 = require_module_relative './fixtures/some_lib'
+
+    expect(mod.inspect).to end_with 'FixturesSomeLib'
+    expect(mod2.inspect).to end_with 'FixturesSomeLib'
+
+    expect(mod <=> mod2).to eq 0
+  end
+
+  it 'test without cache' do
+    mod = require_module_relative('./fixtures/some_lib.rb', cache: false)
+
+    expect(mod.inspect).to start_with '#<Module:'
+    expect(mod.some_fn).to eq 'some_val'
+  end
+
+  it 'test without cache and ext' do
+    mod = require_module_relative('./fixtures/some_lib', cache: false)
+
+    expect(mod.inspect).to start_with '#<Module:'
+    expect(mod.some_fn).to eq 'some_val'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start
+
+require_relative '../lib/require_module'
+
+RSpec.configure do |config|
+  config.color = true
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: require_module
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sergey Homa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-15 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: melgaardbjorn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/require_module.rb
+- require_module.gemspec
+- spec/fixtures/some_lib.rb
+- spec/require_module_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/BjornMelgaard/require_module
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title"
+- require_all
+- "--main"
+- README.md
+- "--line-numbers"
+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.7.4
+signing_key: 
+specification_version: 4
+summary: Evaluates file content inside Module.new, with cache
+test_files:
+- spec/fixtures/some_lib.rb
+- spec/require_module_spec.rb
+- spec/spec_helper.rb