share-paths 0.1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e482d8e8ceb3760ac833d8835601a6178c892b96
+  data.tar.gz: 4fcab8534285345a751919c8c7fa0a5526e25de8
+SHA512:
+  metadata.gz: 7e28449fa8fa2a3d2e0b3c2ded8e2f2d2f0bae15a03f3bef1680936c1173d3524931c39be80169312840fec6fabbe2c881a50480723a23bc0e422df68c9da762
+  data.tar.gz: 21504da1859d3587edfff7864ff96d16be84dab087b91197b2c0dc40ea5ed63218ff28cdd0784a32ccfe7978c14e6b459e1ce71ebbf076a49588fc8a0d807963

data/LICENSE

@@ -0,0 +1,166 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
+

data/README.md

@@ -0,0 +1,29 @@
+# share-paths
+
+Manage search paths provided by some gems.
+
+[![Gem Version](https://badge.fury.io/rb/share-paths.svg)](http://badge.fury.io/rb/share-paths)
+[![GitHub license](https://img.shields.io/badge/license-LGPLv3-orange.svg?style=flat)](https://raw.githubusercontent.com/shikhalev/share-paths/master/LICENSE)
+[![Code Climate](https://codeclimate.com/github/shikhalev/share-paths/badges/gpa.svg)](https://codeclimate.com/github/shikhalev/share-paths)
+
+## Usage
+
+At gems place your share files in `<gemroot>/share` directory and add to source
+code:
+
+```Ruby
+require 'share-paths'
+
+Share::register_vendor_path
+```
+
+At application find share files by:
+
+```Ruby
+js = Share['js/myscript.js']
+css = Share['css/darc.css']
+```
+
+## License
+
+* [GNU Lesser General Public License v3](LICENSE)

data/lib/share-paths.rb

@@ -0,0 +1,196 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+module Share
+
+  VERSION = [ 0, 1 ]
+
+  class Error < StandardError; end
+
+  def appname
+    @@appname ||= File.basename $0, '.rb'
+    @@appname
+  end
+
+  def set_appname name
+    case name
+    when nil
+      @@appname = File.basename $0, '.rb'
+    when String, Symbol
+      @@appname = name.to_s
+    else
+      raise Error, "#{name.inspect} is not a valid application name!", caller
+    end
+  end
+
+  module_function :appname, :set_appname
+
+  def default_system_path
+    "/var/share/#{appname}"
+  end
+
+  def system_path
+    @@system_path ||= default_system_path
+    @@system_path
+  end
+
+  def set_system_path path
+    case path
+    when nil
+      @@system_path = default_system_path
+    when String
+      @@system_path = File.expand_path path
+    else
+      raise Error, "#{path.inspect} is not a valid path!", caller
+    end
+  end
+
+  module_function :default_system_path, :system_path, :set_system_path
+
+  def default_user_path
+    File.expand_path "~/.local/share/#{appname}"
+  end
+
+  def user_path
+    @@user_path ||= default_user_path
+    @@user_path
+  end
+
+  def set_user_path path
+    case path
+    when nil
+      @@user_path = default_user_path
+    when String
+      @@user_path = File.expand_path path
+    else
+      raise Error, "#{path.inspect} is not a valid path!", caller
+    end
+  end
+
+  module_function :default_user_path, :user_path, :set_user_path
+
+  def default_instance_path
+    File.expand_path './share'
+  end
+
+  def instance_path
+    @@instance_path ||= default_instance_path
+    @@instance_path
+  end
+
+  def set_instance_path path
+    case path
+    when nil
+      @@instance_path = default_instance_path
+    when String
+      @@instance_path = File.expand_path path
+    else
+      raise Error, "#{path.inspect} is not a valid path!", caller
+    end
+  end
+
+  module_function :default_instance_path, :instance_path, :set_instance_path
+
+  def vendor_paths
+    @@vendor_paths ||= []
+    @@vendor_paths
+  end
+
+  def share_by_src src
+    spec = Gem::Specification.find do |spc|
+      File.fnmatch File.join(spc.full_gem_path, '*'), src
+    end
+    if spec
+      share_by_gem spec
+    elsif src
+      base = src[ /^\/.*\/(lib|bin)\// ]
+      base && File.expand_path('../share', base)
+    else
+      nil
+    end
+  end
+
+  def share_by_gem spec
+    File.expand_path 'share', spec.gem_dir
+  end
+
+  def register_vendor_path *paths
+    if paths.length == 0
+      return register_vendor_path share_by_src(caller_locations[0].path)
+    end
+    @@vendor_paths ||= []
+    result = false
+    paths.each do |pth|
+      case pth
+      when nil
+        next
+      when Gem::Specification
+        full = share_by_gem pth
+      when String
+        full = File.expand_path pth
+      else
+        raise Error, "#{pth.inspect} is not a valid path!", caller
+      end
+      if !@@vendor_paths.include?(full)
+        @@vendor_paths << full
+        result = true
+      end
+    end
+    result
+  end
+
+  module_function :vendor_paths, :share_by_src, :share_by_gem,
+      :register_vendor_path
+
+  def share_paths
+    [ *vendor_paths, *system_path, *user_path, *instance_path ]
+  end
+
+  def find_share_file name
+    if String === name
+      paths = share_paths
+      paths.reverse_each do |path|
+        full = File.expand_path name, path
+        if File.exist? full
+          return full
+        end
+      end
+      nil
+    else
+      raise Error, "#{name.inspect} is not a valid name!", caller
+    end
+  end
+
+  def get_share_file name
+    @@found_files ||= {}
+    @@found_files[name] ||= find_share_file name
+    @@found_files[name]
+  end
+
+  module_function :share_paths, :find_share_file, :get_share_file
+
+  class << self
+
+    alias :appname= :set_appname
+    private :set_appname
+
+    alias :system_path= :set_system_path
+    private :set_system_path
+
+    alias :user_path= :set_user_path
+    private :set_user_path
+
+    alias :instance_path= :set_instance_path
+    private :set_instance_path
+
+    alias :<< :register_vendor_path
+    private :share_by_src, :share_by_gem
+
+    alias :[] :get_share_file
+    alias :to_a :share_paths
+
+  end
+
+end
+

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: share-paths
+version: !ruby/object:Gem::Version
+  version: 0.1.0.3
+platform: ruby
+authors:
+- Ivan Shikhalev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: set_version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Manage search paths provided by some gems.
+email: shikhalev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/share-paths.rb
+homepage: https://github.com/shikhalev/share-paths
+licenses:
+- GNU LGPLv3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Manage search paths provided by some gems
+test_files: []
+has_rdoc: