namespace_helper 1.0.0 → 1.0.1

data/.gitignore

@@ -2,6 +2,8 @@
 nbproject
 .idea
 
+Gemfile.lock
+
 doc
 coverage
 pkg

data/.travis.yml

@@ -1,5 +1,8 @@
 rvm:
+  - 1.8.7
   - 1.9.2
   - 1.9.3
+  - rbx-18mode
   - rbx-19mode
+  - jruby-18mode
   - jruby-19mode

data/HISTORY.md

@@ -1,3 +1,12 @@
+1.0.1 / 2012-??-??
+==================
+
+* 3 minor enhancements
+
+  * Improved documentation
+  * Removed Gemfile.lock for greater flexibility
+  * Made separate version.rb file
+
 1.0.0 / 2012-02-24
 ==================
 

data/README.md

@@ -4,11 +4,11 @@ NamespaceHelper
 [![Build Status](https://secure.travis-ci.org/aef/namespace_helper.png)](
 https://secure.travis-ci.org/aef/namespace_helper)
 
-* [Documentation][1]
-* [Project][2]
+* [Documentation][docs]
+* [Project][project]
 
-   [1]: http://rdoc.info/projects/aef/namespace_helper/
-   [2]: http://github.com/aef/namespace_helper/
+   [docs]:    http://rdoc.info/projects/aef/namespace_helper/
+   [project]: https://github.com/aef/namespace_helper/
 
 Description
 -----------
@@ -22,26 +22,28 @@ Features / Problems
 
 This project tries to conform to:
 
-* [Semantic Versioning (2.0.0-rc.1)][5]
-* [Ruby Packaging Standard (0.5-draft)][6]
-* [Ruby Style Guide][7]
-* [Gem Packaging: Best Practices][8]
+* [Semantic Versioning (2.0.0-rc.1)][semver]
+* [Ruby Packaging Standard (0.5-draft)][rps]
+* [Ruby Style Guide][style]
+* [Gem Packaging: Best Practices][gem]
 
-   [5]: http://semver.org/
-   [6]: http://chneukirchen.github.com/rps/
-   [7]: https://github.com/bbatsov/ruby-style-guide
-   [8]: http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices
+   [semver]: http://semver.org/
+   [rps]:    http://chneukirchen.github.com/rps/
+   [style]:  https://github.com/bbatsov/ruby-style-guide
+   [gem]:    http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices
 
 Additional facts:
 
 * Written purely in Ruby.
-* Intended to be used with Ruby 1.9.2 or compatible.
+* Documented with YARD.
+* Intended to be used with Ruby 1.8.7 or higher.
 * Extends core classes. This can be disabled through bare mode.
+* Cryptographically signed gem and git tags.
 
 Synopsis
 --------
 
-This documentation defines the public interface of the library. Don't rely
+This documentation defines the public interface of the software. Don't rely
 on elements marked as private. Those should be hidden in the documentation
 by default.
 
@@ -109,7 +111,7 @@ File::Constants.namespace_parent_name
 Requirements
 ------------
 
-None
+* Ruby 1.8.7 or higher
 
 Installation
 ------------
@@ -121,9 +123,8 @@ privileges.
 
 There is a high security installation option available through rubygems. It is
 highly recommended over the normal installation, although it may be a bit less
-comfortable. To use the installation method, you will need my public key, which
-I use for cryptographic signatures on all my gems. You can find the public key
-here: http://aef.name/crypto/aef-gem.pem
+comfortable. To use the installation method, you will need my [gem signing
+public key][gemkey], which I use for cryptographic signatures on all my gems.
 
 Add the key to your rubygems' trusted certificates by the following command:
 
@@ -137,6 +138,8 @@ following command:
 Please notice that you may need other keys for dependent libraries, so you may
 have to install dependencies manually.
 
+   [gemkey]: http://aef.name/crypto/aef-gem.pem
+
 ### Normal
 
     gem install namespace_helper
@@ -157,15 +160,41 @@ If something goes wrong you should be noticed through failing examples.
 Development
 -----------
 
+### Bugs Reports and Feature Requests
+
+Please use the [issue tracker][issues] on github.com to let me know about errors
+or ideas for improvement of this software.
+
+   [issues]: https://github.com/aef/namespace_helper/issues/
+
+### Source code
+
 This software is developed in the source code management system git hosted
 at github.com. You can download the most recent sourcecode through the
 following command:
 
     git clone https://github.com/aef/namespace_helper.git
 
+The final commit before each released gem version will be marked by a tag
+named like the version with a prefixed lower-case "v", as required by Semantic
+Versioning. Every tag will be signed by my [OpenPGP public key][openpgp] which
+enables you to verify your copy of the code cryptographically.
+
+   [openpgp]: http://aef.name/crypto/aef-openpgp.asc
+
+Add the key to your GnuPG keyring by the following command:
+
+    gpg --import aef-openpgp.asc
+
+This command will tell you if your code is of integrity and authentic:
+
+    git tag -v [TAG NAME]
+
+### Contribution
+
 Help on making this software better is always very appreciated. If you want
 your changes to be included in the official release, please clone my project
-on github.com, create a named branch to commit and push your changes in and
+on github.com, create a named branch to commit and push your changes into and
 send me a pull request afterwards.
 
 Please make sure to write tests for your changes so that I won't break them

data/Rakefile

@@ -17,9 +17,9 @@ OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 =end
 
+require 'bundler/gem_tasks'
 require 'rake'
 require 'pathname'
-require 'bundler/gem_tasks'
 require 'yard'
 require 'rspec/core/rake_task'
 
@@ -29,7 +29,7 @@ YARD::Rake::YardocTask.new('doc')
 
 desc "Removes temporary project files"
 task :clean do
-  %w{doc coverage pkg .yardoc .rbx}.map{|name| Pathname.new(name) }.each do |path|
+  %w{doc coverage pkg .yardoc .rbx Gemfile.lock}.map{|name| Pathname.new(name) }.each do |path|
     path.rmtree if path.exist?
   end
 
@@ -39,6 +39,7 @@ end
 
 desc "Opens an interactive console with the library loaded"
 task :console do
+  Bundler.setup
   require 'pry'
   require 'namespace_helper'
   Pry.start

data/lib/aef/namespace_helper/version.rb

@@ -0,0 +1,30 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2012
+
+This file is part of NamespaceHelper.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+module Aef
+  module NamespaceHelper
+
+    # The currently loaded library version
+    #
+    # Using Semantic Versioning (2.0.0-rc.1) rules
+    # @see http://semver.org/
+    VERSION = '1.0.1'.freeze
+
+  end
+end

data/lib/aef/namespace_helper.rb

@@ -17,6 +17,8 @@ OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 =end
 
+require 'aef/namespace_helper/version'
+
 # Namespace for projects of Alexander E. Fischer <aef@raxys.net>.
 # 
 # If you want to be able to simply type Example instead of Aef::Example to
@@ -34,9 +36,6 @@ module Aef
   # @see Aef::NamespaceHelper::ClassMethods
   module NamespaceHelper
   
-    # The current library version
-    VERSION = '1.0.0'.freeze
-
     protected
 
     # This magic method is automatically called when NamespaceHelper is

data/namespace_helper.gemspec

@@ -17,9 +17,7 @@ OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 =end
 
-$LOAD_PATH << 'lib'
-
-require 'namespace_helper/bare'
+require File.expand_path('../lib/aef/namespace_helper/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = 'namespace_helper'
@@ -37,20 +35,21 @@ namespace components of a class or module.
 
   s.rubyforge_project = nil
   s.has_rdoc          = 'yard'
-  s.extra_rdoc_files  = ['HISTORY.md', 'LICENSE.md']
+  s.extra_rdoc_files  = ['HISTORY.md', 'LICENSE.md'] 
 
   s.files         = `git ls-files`.lines.map(&:chomp)
   s.test_files    = `git ls-files -- {test,spec,features}/*`.lines.map(&:chomp)
   s.executables   = `git ls-files -- bin/*`.lines.map{|f| File.basename(f.chomp) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency('bundler', '~> 1.0.21')
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.add_development_dependency('bundler', '~> 1.1.3')
   s.add_development_dependency('rake', '~> 0.9.2')
-  s.add_development_dependency('rspec', '~> 2.6.0')
-  s.add_development_dependency('simplecov', '~> 0.5.4')
+  s.add_development_dependency('rspec', '~> 2.8.0')
+  s.add_development_dependency('simplecov', '~> 0.6.1')
   s.add_development_dependency('pry', '~> 0.9.8')
   s.add_development_dependency('yard', '~> 0.7.5')
-  s.add_development_dependency('maruku', '~> 0.6.0')
 
   s.cert_chain = "#{ENV['GEM_CERT_CHAIN']}".split(':')
   s.signing_key = ENV['GEM_SIGNING_KEY']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: namespace_helper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -48,22 +48,22 @@ cert_chain:
   -----END CERTIFICATE-----
 
 '
-date: 2012-02-24 00:00:00.000000000 Z
+date: 2012-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &10350060 !ruby/object:Gem::Requirement
+  requirement: &17859860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.21
+        version: 1.1.3
   type: :development
   prerelease: false
-  version_requirements: *10350060
+  version_requirements: *17859860
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &10348240 !ruby/object:Gem::Requirement
+  requirement: &17859340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -71,32 +71,32 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *10348240
+  version_requirements: *17859340
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &10347220 !ruby/object:Gem::Requirement
+  requirement: &17858860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *10347220
+  version_requirements: *17858860
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &10361840 !ruby/object:Gem::Requirement
+  requirement: &17858380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.4
+        version: 0.6.1
   type: :development
   prerelease: false
-  version_requirements: *10361840
+  version_requirements: *17858380
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &10357220 !ruby/object:Gem::Requirement
+  requirement: &17857920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -104,10 +104,10 @@ dependencies:
         version: 0.9.8
   type: :development
   prerelease: false
-  version_requirements: *10357220
+  version_requirements: *17857920
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &10356380 !ruby/object:Gem::Requirement
+  requirement: &17857460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -115,18 +115,7 @@ dependencies:
         version: 0.7.5
   type: :development
   prerelease: false
-  version_requirements: *10356380
-- !ruby/object:Gem::Dependency
-  name: maruku
-  requirement: &10370880 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: *10370880
+  version_requirements: *17857460
 description: ! 'NamespaceHelper provides a module with methods to ease namespace handling.
 
   For example getting the unprefixed name, the namespace parent or a list of
@@ -147,12 +136,12 @@ files:
 - .travis.yml
 - .yardopts
 - Gemfile
-- Gemfile.lock
 - HISTORY.md
 - LICENSE.md
 - README.md
 - Rakefile
 - lib/aef/namespace_helper.rb
+- lib/aef/namespace_helper/version.rb
 - lib/namespace_helper.rb
 - lib/namespace_helper/bare.rb
 - namespace_helper.gemspec
@@ -170,7 +159,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/Gemfile.lock

@@ -1,54 +0,0 @@
-PATH
-  remote: .
-  specs:
-    namespace_helper (1.0.0rc1)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    coderay (1.0.5)
-    diff-lcs (1.1.3)
-    maruku (0.6.0)
-      syntax (>= 1.0.0)
-    method_source (0.7.0)
-    multi_json (1.0.4)
-    pry (0.9.8.2)
-      coderay (~> 1.0.5)
-      method_source (~> 0.7)
-      slop (>= 2.4.4, < 3)
-    pry (0.9.8.2-java)
-      coderay (~> 1.0.5)
-      method_source (~> 0.7)
-      slop (>= 2.4.4, < 3)
-      spoon (~> 0.0)
-    rake (0.9.2.2)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
-    simplecov (0.5.4)
-      multi_json (~> 1.0.3)
-      simplecov-html (~> 0.5.3)
-    simplecov-html (0.5.3)
-    slop (2.4.4)
-    spoon (0.0.1)
-    syntax (1.0.0)
-    yard (0.7.5)
-
-PLATFORMS
-  java
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0.21)
-  maruku (~> 0.6.0)
-  namespace_helper!
-  pry (~> 0.9.8)
-  rake (~> 0.9.2)
-  rspec (~> 2.6.0)
-  simplecov (~> 0.5.4)
-  yard (~> 0.7.5)