lotus-utils 0.1.1 → 0.2.0

data/lib/lotus/utils/load_paths.rb

@@ -0,0 +1,149 @@
+require 'lotus/utils/kernel'
+
+module Lotus
+  module Utils
+    # A collection of loading paths.
+    #
+    # @since 0.2.0
+    class LoadPaths
+      # Initialize a new collection for the given paths
+      #
+      # @param paths [String, Pathname, Array<String>, Array<Pathname>] A single
+      #   or a collection of objects that can be converted into a Pathname
+      #
+      # @return [Lotus::Utils::LoadPaths] self
+      #
+      # @since 0.2.0
+      #
+      # @see http://ruby-doc.org/stdlib-2.1.2/libdoc/pathname/rdoc/Pathname.html
+      # @see Lotus::Utils::Kernel.Pathname
+      def initialize(*paths)
+        @paths = Array(paths)
+      end
+
+      # It specifies the policy for initialize copies of the object, when #clone
+      # or #dup are invoked.
+      #
+      # @api private
+      # @since 0.2.0
+      #
+      # @see http://ruby-doc.org/core-2.1.2/Object.html#method-i-clone
+      # @see http://ruby-doc.org/core-2.1.2/Object.html#method-i-dup
+      #
+      # @example
+      #   require 'lotus/utils/load_paths'
+      #
+      #   paths  = Lotus::Utils::LoadPaths.new '.'
+      #   paths2 = paths.dup
+      #
+      #   paths  << '..'
+      #   paths2 << '../..'
+      #
+      #   paths
+      #     # => #<Lotus::Utils::LoadPaths:0x007f84e0cad430 @paths=[".", ".."]>
+      #
+      #   paths2
+      #     # => #<Lotus::Utils::LoadPaths:0x007faedc4ad3e0 @paths=[".", "../.."]>
+      def initialize_copy(original)
+        @paths = original.instance_variable_get(:@paths).dup
+      end
+
+      # Iterates thru the collection and yields the given block.
+      # It skips duplications and raises an error in case one of the paths
+      # doesn't exist.
+      #
+      # @param blk [Proc] the block of code to be yielded
+      #
+      # @return [void]
+      #
+      # @raise [Errno::ENOENT] if one of the paths doesn't exist
+      #
+      # @since 0.2.0
+      def each(&blk)
+        Utils::Kernel.Array(@paths).each do |path|
+          blk.call realpath(path)
+        end
+      end
+
+      # Adds the given path(s).
+      #
+      # It returns self, so that multiple operations can be performed.
+      #
+      # @param paths [String, Pathname, Array<String>, Array<Pathname>] A single
+      #   or a collection of objects that can be converted into a Pathname
+      #
+      # @return [Lotus::Utils::LoadPaths] self
+      #
+      # @raise [RuntimeError] if the object was previously frozen
+      #
+      # @since 0.2.0
+      #
+      # @see http://ruby-doc.org/stdlib-2.1.2/libdoc/pathname/rdoc/Pathname.html
+      # @see Lotus::Utils::Kernel.Pathname
+      # @see Lotus::Utils::LoadPaths#freeze
+      #
+      # @example Basic usage
+      #   require 'lotus/utils/load_paths'
+      #
+      #   paths = Lotus::Utils::LoadPaths.new
+      #   paths.push '.'
+      #   paths.push '..', '../..'
+      #
+      # @example Chainable calls
+      #   require 'lotus/utils/load_paths'
+      #
+      #   paths = Lotus::Utils::LoadPaths.new
+      #   paths.push('.')
+      #        .push('..', '../..')
+      #
+      # @example Shovel alias (#<<)
+      #   require 'lotus/utils/load_paths'
+      #
+      #   paths = Lotus::Utils::LoadPaths.new
+      #   paths << '.'
+      #   paths << ['..', '../..']
+      #
+      # @example Chainable calls with shovel alias (#<<)
+      #   require 'lotus/utils/load_paths'
+      #
+      #   paths = Lotus::Utils::LoadPaths.new
+      #   paths << '.' << '../..'
+      def push(*paths)
+        @paths.push(*paths)
+        self
+      end
+
+      alias_method :<<, :push
+
+      # It freezes the object by preventing further modifications.
+      #
+      # @since 0.2.0
+      #
+      # @see http://ruby-doc.org/core-2.1.2/Object.html#method-i-freeze
+      #
+      # @example
+      #   require 'lotus/utils/load_paths'
+      #
+      #   paths = Lotus::Utils::LoadPaths.new
+      #   paths.freeze
+      #
+      #   paths.frozen?  # => true
+      #
+      #   paths.push '.' # => RuntimeError
+      def freeze
+        super
+        @paths.freeze
+      end
+
+      private
+      # Allow subclasses to define their own policy to discover the realpath
+      # of the given path.
+      #
+      # @since 0.2.0
+      # @api private
+      def realpath(path)
+        Utils::Kernel.Pathname(path).realpath
+      end
+    end
+  end
+end

data/lib/lotus/utils/string.rb

@@ -78,6 +78,24 @@ module Lotus
         split(NAMESPACE_SEPARATOR).last
       end
 
+      # Return the top level namespace name
+      #
+      # @return [String] the transformed string
+      #
+      # @since 0.1.2
+      #
+      # @example
+      #   require 'lotus/utils/string'
+      #
+      #   string = Lotus::Utils::String.new 'Lotus::Utils::String'
+      #   string.namespace # => 'Lotus'
+      #
+      #   string = Lotus::Utils::String.new 'String'
+      #   string.namespace # => 'String'
+      def namespace
+        split(NAMESPACE_SEPARATOR).first
+      end
+
       # It iterates thru the tokens and calls the given block.
       # A token is a substring wrapped by `()` and separated by `|`.
       #

data/lib/lotus/utils/version.rb

@@ -1,5 +1,5 @@
 module Lotus
   module Utils
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

data/lotus-utils.gemspec

@@ -13,11 +13,11 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'http://lotusrb.org'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files -- lib/* CHANGELOG.md LICENSE.md README.md lotus-utils.gemspec`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake',    '~> 10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lotus-utils
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2014-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -45,15 +45,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- ".yardopts"
 - CHANGELOG.md
-- CONTRIBUTING.md
-- Gemfile
 - LICENSE.md
 - README.md
-- Rakefile
 - lib/lotus/utils.rb
 - lib/lotus/utils/callbacks.rb
 - lib/lotus/utils/class.rb
@@ -61,20 +55,11 @@ files:
 - lib/lotus/utils/hash.rb
 - lib/lotus/utils/io.rb
 - lib/lotus/utils/kernel.rb
+- lib/lotus/utils/load_paths.rb
 - lib/lotus/utils/path_prefix.rb
 - lib/lotus/utils/string.rb
 - lib/lotus/utils/version.rb
 - lotus-utils.gemspec
-- test/callbacks_test.rb
-- test/class_attribute_test.rb
-- test/class_test.rb
-- test/hash_test.rb
-- test/io_test.rb
-- test/kernel_test.rb
-- test/path_prefix_test.rb
-- test/string_test.rb
-- test/test_helper.rb
-- test/version_test.rb
 homepage: http://lotusrb.org
 licenses:
 - MIT
@@ -99,15 +84,5 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby core extentions and Louts utilities
-test_files:
-- test/callbacks_test.rb
-- test/class_attribute_test.rb
-- test/class_test.rb
-- test/hash_test.rb
-- test/io_test.rb
-- test/kernel_test.rb
-- test/path_prefix_test.rb
-- test/string_test.rb
-- test/test_helper.rb
-- test/version_test.rb
+test_files: []
 has_rdoc: 

data/.gitignore

@@ -1,20 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.devnotes
-.greenbar
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-bin

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-script: 'bundle exec rake test:coverage'
-rvm:
-  - 2.0.0
-  - 2.1.0
-  - 2.1.1

data/.yardopts

@@ -1,3 +0,0 @@
--
-LICENSE.txt
-lib/**/*.rb

data/CONTRIBUTING.md

@@ -1,44 +0,0 @@
-## Contributing
-In the spirit of [free software][free-sw], **everyone** is encouraged to help
-improve this project.
-
-[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
-
-Here are some ways *you* can contribute:
-
-* by using alpha, beta, and prerelease versions
-* by reporting bugs
-* by suggesting new features
-* by writing or editing documentation
-* by writing specifications
-* by writing code (**no patch is too small**: fix typos, add comments, clean up
-  inconsistent whitespace)
-* by refactoring code
-* by closing [issues][]
-* by reviewing patches
-
-[issues]: https://github.com/lotus/utils/issues
-
-## Submitting an Issue
-We use the [GitHub issue tracker][issues] to track bugs and features. Before
-submitting a bug report or feature request, check to make sure it hasn't
-already been submitted. When submitting a bug report, please include a [Gist][]
-that includes a stack trace and any details that may be necessary to reproduce
-the bug, including your gem version, Ruby version, and operating system.
-Ideally, a bug report should include a pull request with failing specs.
-
-[gist]: https://gist.github.com/
-
-## Submitting a Pull Request
-1. [Fork the repository.][fork]
-2. [Create a topic branch.][branch]
-3. Add specs for your unimplemented feature or bug fix.
-4. Run `bundle exec rake`. If your specs pass, return to step 3.
-5. Implement your feature or bug fix.
-6. Run `bundle exec rake`. If your specs fail, return to step 5.
-7. Add, commit, and push your changes.
-8. [Submit a pull request.][pr]
-
-[fork]: http://help.github.com/fork-a-repo/
-[branch]: http://learn.github.com/p/branching.html
-[pr]: http://help.github.com/send-pull-requests/

data/Gemfile

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-gemspec
-
-unless ENV['TRAVIS']
-  gem 'byebug', require: false, platforms: :ruby if RUBY_VERSION == '2.1.1'
-  gem 'yard',   require: false
-end
-
-gem 'simplecov', require: false
-gem 'coveralls', require: false

data/Rakefile

@@ -1,17 +0,0 @@
-require 'rake'
-require 'rake/testtask'
-require 'bundler/gem_tasks'
-
-Rake::TestTask.new do |t|
-  t.pattern = 'test/**/*_test.rb'
-  t.libs.push 'test'
-end
-
-namespace :test do
-  task :coverage do
-    ENV['COVERAGE'] = 'true'
-    Rake::Task['test'].invoke
-  end
-end
-
-task default: :test

data/test/callbacks_test.rb

@@ -1,213 +0,0 @@
-require 'test_helper'
-require 'lotus/utils/callbacks'
-
-class Callable
-  def call
-  end
-end
-
-class Action
-  attr_reader :logger
-
-  def initialize
-    @logger = Array.new
-  end
-
-  private
-  def authenticate!
-    logger.push 'authenticate!'
-  end
-
-  def set_article(params)
-    logger.push "set_article: #{ params[:id] }"
-  end
-end
-
-describe Lotus::Utils::Callbacks::Chain do
-  before do
-    @chain = Lotus::Utils::Callbacks::Chain.new
-  end
-
-  describe '#add' do
-    it 'wraps the given callback with a callable object' do
-      @chain.add :symbolize!
-
-      cb = @chain.first
-      cb.must_respond_to(:call)
-    end
-
-    describe 'when a callable object is passed' do
-      before do
-        @chain.add callback
-      end
-
-      let(:callback) { Callable.new }
-
-      it 'includes the given callback' do
-        cb = @chain.first
-        cb.callback.must_equal(callback)
-      end
-    end
-
-    describe 'when a Symbol is passed' do
-      before do
-        @chain.add callback
-      end
-
-      let(:callback) { :upcase }
-
-      it 'includes the given callback' do
-        cb = @chain.first
-        cb.callback.must_equal(callback)
-      end
-
-      it 'guarantees unique entries' do
-        # add the callback again, see before block
-        @chain.add callback
-        @chain.size.must_equal(1)
-      end
-    end
-
-    describe 'when a block is passed' do
-      before do
-        @chain.add(&callback)
-      end
-
-      let(:callback) { Proc.new{} }
-
-      it 'includes the given callback' do
-        cb = @chain.first
-        assert_equal cb.callback, callback
-      end
-    end
-
-    describe 'when multiple callbacks are passed' do
-      before do
-        @chain.add *callbacks
-      end
-
-      let(:callbacks) { [:upcase, Callable.new, Proc.new{}] }
-
-      it 'includes all the given callbacks' do
-        @chain.size.must_equal(callbacks.size)
-      end
-
-      it 'all the included callbacks are callable' do
-        @chain.each do |callback|
-          callback.must_respond_to(:call)
-        end
-      end
-    end
-  end
-
-  describe '#run' do
-    let(:action) { Action.new }
-    let(:params) { Hash[id: 23] }
-
-    describe 'when symbols are passed' do
-      before do
-        @chain.add :authenticate!, :set_article
-        @chain.run action, params
-      end
-
-      it 'executes the callbacks' do
-        authenticate = action.logger.shift
-        authenticate.must_equal 'authenticate!'
-
-        set_article = action.logger.shift
-        set_article.must_equal "set_article: #{ params[:id] }"
-      end
-    end
-
-    describe 'when procs are passed' do
-      before do
-        @chain.add do
-          logger.push 'authenticate!'
-        end
-
-        @chain.add do |params|
-          logger.push "set_article: #{ params[:id] }"
-        end
-
-        @chain.run action, params
-      end
-
-      it 'executes the callbacks' do
-        authenticate = action.logger.shift
-        authenticate.must_equal 'authenticate!'
-
-        set_article = action.logger.shift
-        set_article.must_equal "set_article: #{ params[:id] }"
-      end
-    end
-  end
-end
-
-describe Lotus::Utils::Callbacks::Factory do
-  describe '.fabricate' do
-    before do
-      @callback = Lotus::Utils::Callbacks::Factory.fabricate(callback)
-    end
-
-    describe 'when a callable is passed' do
-      let(:callback) { Callable.new }
-
-      it 'fabricates a Callback' do
-        @callback.must_be_kind_of(Lotus::Utils::Callbacks::Callback)
-      end
-
-      it 'wraps the given callback' do
-        @callback.callback.must_equal(callback)
-      end
-    end
-
-    describe 'when a symbol is passed' do
-      let(:callback) { :symbolize! }
-
-      it 'fabricates a MethodCallback' do
-        @callback.must_be_kind_of(Lotus::Utils::Callbacks::MethodCallback)
-      end
-
-      it 'wraps the given callback' do
-        @callback.callback.must_equal(callback)
-      end
-    end
-  end
-end
-
-describe Lotus::Utils::Callbacks::Callback do
-  before do
-    @callback = Lotus::Utils::Callbacks::Callback.new(callback)
-  end
-
-  let(:callback) { Proc.new{|params| logger.push("set_article: #{ params[:id] }") } }
-
-  it 'executes self within the given context' do
-    context = Action.new
-    @callback.call(context, { id: 23 })
-
-    invokation = context.logger.shift
-    invokation.must_equal("set_article: 23")
-  end
-end
-
-describe Lotus::Utils::Callbacks::MethodCallback do
-  before do
-    @callback = Lotus::Utils::Callbacks::MethodCallback.new(callback)
-  end
-
-  let(:callback) { :set_article }
-
-  it 'executes self within the given context' do
-    context = Action.new
-    @callback.call(context, { id: 23 })
-
-    invokation = context.logger.shift
-    invokation.must_equal("set_article: 23")
-  end
-
-  it 'implements #hash' do
-    cb = Lotus::Utils::Callbacks::MethodCallback.new(callback)
-    cb.send(:hash).must_equal(@callback.send(:hash))
-  end
-end