jeweler 2.1.2 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f898b851a0caf0e3daaeb214f7f322c2f3ca478
-  data.tar.gz: e5fb878c6b2dcfbdcb4a1f5a910cbf9dadb88656
+  metadata.gz: 8c47c5eda7696e69db59a88eff4af831c67757fd
+  data.tar.gz: 98f650076b291ba872f9600fe984df47e55da57c
 SHA512:
-  metadata.gz: b7c2b407725d7e1e5a77109de1c7c5788897fd1febb6745581ac1a499469e6c334dd4a3544bca99819d997df7b39005ff03d7a5d7914d232f2c7aba2247decc3
-  data.tar.gz: 553209940769eb7d73e592f140bc443ebd4d6d8a70945fedb123b229903f8033a7b639d07307e146480ca2b1e60d0d96c1a35eacb945c73806dc2701b6109785
+  metadata.gz: 262606cb12580564221b5f80c1e18565d2aac1d8562a186aa8275621341917fe8d394d0229514226d15db6295de0d5282e29176ef21ddbb2d1f9bac08e98f78f
+  data.tar.gz: e36802e7601e774a82fc0513043f4e1db187ab1be8288e3d9d751317087865e0ad16c6dec07afed4b2eaf122df7d16919b766dc2c86f127186bacea9c6c7d583

data/.semver

@@ -1,5 +1,5 @@
 ---
 :major: 2
-:minor: 1
-:patch: 2
+:minor: 2
+:patch: 1
 :special: ''

data/.travis.yml

@@ -2,10 +2,8 @@ language: ruby
 before_install: 'gem update bundler'
 install: 'bundle install --jobs=3 --retry=3' # Suppress the --deployment flag'
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.2.0
+  - 2.2.2
   - 2.3.0
+  - 2.3.1
 notifications:
   irc: "irc.freenode.org#jeweler"

data/ChangeLog.markdown

@@ -1,3 +1,6 @@
+# jeweler 2.2.1
+	* Added a patch for a potential psych problem that hit juwelier.
+				
 # jeweler 2.1.2, 2016-10-22
   * Merged pull requests to support breaking changes to the Bundler API (thanks julik)
   * Updated gem dependencies		

data/Gemfile

@@ -9,6 +9,7 @@ gem 'bundler', '>= 1.0'
 gem 'rdoc'
 gem 'builder'
 gem "semver"
+gem "psych", "~> 2.2"
 
 group :development do
   gem 'yard', '>= 0.8.5'

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    jeweler (2.1.2)
+    jeweler (2.2.1)
       builder
       bundler (>= 1.0)
       git (>= 1.2.5)
       github_api (~> 0.11.0)
       highline (>= 1.6.15)
       nokogiri (>= 1.5.10)
+      psych (~> 2.2)
       rake
       rdoc
       semver
@@ -18,7 +19,8 @@ GEM
     activesupport (3.2.22.5)
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
-    addressable (2.4.0)
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
     bluecloth (2.2.0)
     builder (3.2.2)
     coveralls (0.8.15)
@@ -57,7 +59,7 @@ GEM
     hashie (3.4.6)
     highline (1.7.8)
     i18n (0.7.0)
-    json (1.8.3)
+    json (2.0.2)
     jwt (1.5.6)
     metaclass (0.0.4)
     mhennemeyer-output_catcher (1.0.1)
@@ -77,17 +79,18 @@ GEM
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
     power_assert (0.3.1)
+    psych (2.2.0)
+    public_suffix (2.0.4)
     rack (2.0.1)
     rake (11.3.0)
-    rdoc (4.2.2)
-      json (~> 1.4)
+    rdoc (5.0.0)
     redgreen (1.2.2)
     rr (1.2.0)
     semver (1.0.1)
     shoulda (3.5.0)
       shoulda-context (~> 1.0, >= 1.0.1)
       shoulda-matchers (>= 1.4.1, < 3.0)
-    shoulda-context (1.2.1)
+    shoulda-context (1.2.2)
     shoulda-matchers (2.8.0)
       activesupport (>= 3.0.0)
     simplecov (0.12.0)
@@ -97,7 +100,7 @@ GEM
     simplecov-html (0.10.0)
     term-ansicolor (1.4.0)
       tins (~> 1.0)
-    test-unit (3.2.1)
+    test-unit (3.2.2)
       power_assert
     test-unit-rr (1.0.5)
       rr (>= 1.1.1)
@@ -126,6 +129,7 @@ DEPENDENCIES
   mhennemeyer-output_catcher
   mocha
   nokogiri (>= 1.5.10)
+  psych (~> 2.2)
   rake
   rdoc
   redgreen
@@ -139,4 +143,4 @@ DEPENDENCIES
   yard (>= 0.8.5)
 
 BUNDLED WITH
-   1.12.5
+   1.13.6

data/README.org

@@ -0,0 +1,375 @@
+/Jeweler maintenance has now shifted to Fred Mitchell/. I am now
+maintaining both Jeweler and its fork, juwelier. I will keep Jeweler at
+least functional with the latest Ruby releases, but put new features in
+Juwelier. Your input on this is more than welcome.
+
+* Jeweler: Craft the perfect RubyGem
+
+[[https://gitter.im/technicalpickles/jeweler?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge][[[https://badges.gitter.im/technicalpickles/jeweler.svg]]]]
+
+Jeweler provides the noble ruby developer with two primary features:
+
+-  a library for managing and releasing RubyGem projects
+-  a scaffold generator for starting new RubyGem projects
+
+PLEASE NOTE that if you are starting afresh, please use the successor
+[[https://github.com/flajann2/juwelier][Juwelier]] I (Fred Mitchell,
+flajann2) will be maintaining both Jeweler and Juwelier, but will be
+adding new features to Juwelier, and eventually "merge" this one into
+Juwelier after some namespace issues are dealt with.
+
+[[https://travis-ci.org/technicalpickles/jeweler][[[https://travis-ci.org/technicalpickles/jeweler.png]]]]
+[[https://coveralls.io/r/technicalpickles/jeweler][[[https://coveralls.io/repos/technicalpickles/jeweler/badge.png]]]]
+[[https://www.versioneye.com/ruby/jeweler/2.0.0][[[https://www.versioneye.com/ruby/jeweler/2.0.0/badge.png]]]]
+[[https://codeclimate.com/github/technicalpickles/jeweler][[[https://codeclimate.com/github/technicalpickles/jeweler/badges/gpa.svg]]]]
+
+** Hello, world
+
+Use RubyGems to install the heck out of jeweler to get started:
+
+#+BEGIN_EXAMPLE
+    $ gem install jeweler
+#+END_EXAMPLE
+
+With jeweler installed, you can use the =jeweler= command to generate a
+new project. For the most basic use, just give it a name:
+
+#+BEGIN_EXAMPLE
+    $ jeweler hello-gem
+#+END_EXAMPLE
+
+This requires some Git configuration (like name, email, GitHub account,
+etc), but =jeweler= will prompt along the way.
+
+Your new =hello-gem= gem is ready in the =hello-gem= directory. Take a
+peek, and you'll see several files and directories
+
+-  =Rakefile= setup for jeweler, running tests, generating
+   documentation, and releasing to
+   [[http://rubygems.org/][rubygems.org]]
+-  =README.rdoc= with contribution guidelines and copyright info
+   crediting you
+-  =LICENSE= with the MIT licensed crediting you
+-  =Gemfile= with development dependencies filled in
+-  =lib/hello-gem.rb= waiting for you to code
+-  =test/= containing a (failing) shoulda test suite
+   [[http://github.com/thoughtbot/shoulda][shoulda]]
+
+*** More =jeweler= options
+
+The =jeweler= command supports a lot of options. Mostly, they are for
+generating baked in support for this test framework, or that.
+
+Check out =jeweler --help= for the most up to date options.
+
+** Hello, rake tasks
+
+Beyond just editing source code, you'll be interacting with your gem
+using =rake= a lot. To see all the tasks available with a brief
+description, you can run:
+
+#+BEGIN_EXAMPLE
+    $ rake -T
+#+END_EXAMPLE
+
+You'll need a version before you can start installing your gem locally.
+The easiest way is with the =version:write= Rake task. Let's imagine you
+start with 0.1.0
+
+#+BEGIN_EXAMPLE
+    $ rake version:write MAJOR=0 MINOR=1 PATCH=0
+#+END_EXAMPLE
+
+You can now go forth and develop, now that there's an initial version
+defined. Eventually, you should install and test the gem:
+
+#+BEGIN_EXAMPLE
+    $ rake install
+#+END_EXAMPLE
+
+The =install= rake task builds the gem and =gem install=s it. You're all
+set if you're using [[http://rvm.beginrescueend.com/][RVM]], but you may
+need to run it with sudo if you have a system-installed ruby:
+
+#+BEGIN_EXAMPLE
+    $ sudo rake install
+#+END_EXAMPLE
+
+*** Releasing
+
+At last, it's time to [[http://shipitsquirrel.github.com/][ship it]]!
+Make sure you have everything committed and pushed, then go wild:
+
+#+BEGIN_EXAMPLE
+    $ rake release
+#+END_EXAMPLE
+
+This will automatically:
+
+-  Generate =hello-gem.gemspec= and commit it
+-  Use =git= to tag =v0.1.0= and push it
+-  Build =hello-gem-0.1.0.gem= and push it to
+   [[http://rubygems.org/gems/][rubygems.org]]
+
+=rake release= accepts REMOTE(default: =origin=), LOCAL\_BRANCH(default:
+=master=), REMOTE\_BRANCH(default: =master=) and BRANCH(default:
+master)as options.
+
+#+BEGIN_EXAMPLE
+    $ rake release REMOTE=upstream LOCAL_BRANCH=critical-security-fix REMOTE_BRANCH=v3
+#+END_EXAMPLE
+
+This will tag and push the commits on your local branch named
+=critical-security-fix= to branch named =v3= in remote named =upstream=
+(if you have commit rights on =upstream=) and release the gem.
+
+#+BEGIN_EXAMPLE
+    $ rake release BRANCH=v3
+#+END_EXAMPLE
+
+If both remote and local branches are the same, use =BRANCH= option to
+simplify. This will tag and push the commits on your local branch named
+=v3= to branch named =v3= in remote named =origin= (if you have commit
+rights on =origin=) and release the gem.
+
+*** Version bumping
+
+It feels good to release code. Do it, do it often. But before that, bump
+the version. Then release it. There's a few ways to update the version:
+
+#+BEGIN_EXAMPLE
+    # version:write like before
+    $ rake version:write MAJOR=0 MINOR=3 PATCH=0
+
+    # bump just major, ie 0.1.0 -> 1.0.0
+    $ rake version:bump:major
+
+    # bump just minor, ie 0.1.0 -> 0.2.0
+    $ rake version:bump:minor
+
+    # bump just patch, ie 0.1.0 -> 0.1.1
+    $ rake version:bump:patch
+#+END_EXAMPLE
+
+Then it's the same =release= we used before:
+
+#+BEGIN_EXAMPLE
+    $ rake release
+#+END_EXAMPLE
+
+** Customizing your gem
+
+If you've been following along so far, your gem is just a blank slate.
+You're going to need to make it colorful and full of metadata.
+
+You can customize your gem by updating your =Rakefile=. With a newly
+generated project, it will look something like this:
+
+#+BEGIN_EXAMPLE
+    require 'jeweler'
+    Jeweler::Tasks.new do |gem|
+      # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+      gem.name = "whatwhatwhat"
+      gem.summary = %Q{TODO: one-line summary of your gem}
+      gem.description = %Q{TODO: longer description of your gem}
+      gem.email = "josh@technicalpickles.com"
+      gem.homepage = "http://github.com/technicalpickles/whatwhatwhat"
+      gem.authors = ["Joshua Nichols"]
+    end
+    Jeweler::RubygemsDotOrgTasks.new
+#+END_EXAMPLE
+
+It's crucial to understand the =gem= object is just a
+Gem::Specification. You can read up about it at
+[[http://guides.rubygems.org/specification-reference/][guides.rubygems.org/specification-reference]].
+This is the most basic way of specifying a gem, Jeweler-managed or not.
+Jeweler just exposes this to you, in addition to providing some
+reasonable defaults, which we'll explore now.
+
+*** Project information
+
+#+BEGIN_EXAMPLE
+    gem.name = "whatwhatwhat"
+#+END_EXAMPLE
+
+Every gem has a name. Among other things, the gem name is how you are
+able to =gem install= it.
+[[http://guides.rubygems.org/specification-reference/#name][Reference]]
+
+#+BEGIN_EXAMPLE
+    gem.summary = %Q{TODO: one-line summary of your gem}
+#+END_EXAMPLE
+
+This is a one line summary of your gem. This is displayed, for example,
+when you use =gem list --details= or view it on
+[[http://rubygems.org/gems/][rubygems.org]].
+
+#+BEGIN_EXAMPLE
+    gem.description = %Q{TODO: longer description of your gem}
+#+END_EXAMPLE
+
+Description is a longer description. Scholars ascertain that knowledge
+of where the description is used was lost centuries ago.
+
+#+BEGIN_EXAMPLE
+    gem.email = "josh@technicalpickles.com"
+#+END_EXAMPLE
+
+This should be a way to get a hold of you regarding the gem.
+
+#+BEGIN_EXAMPLE
+    gem.homepage = "http://github.com/technicalpickles/whatwhatwhat"
+#+END_EXAMPLE
+
+The homepage should have more information about your gem. The jeweler
+generator guesses this based on the assumption your code lives on
+[[http://github.com/][GitHub]], using your Git configuration to find
+your GitHub username. This is displayed by =gem list --details= and on
+rubygems.org.
+
+#+BEGIN_EXAMPLE
+    gem.authors = ["Joshua Nichols"]
+#+END_EXAMPLE
+
+Hey, this is you, the author (or me in this case). The =jeweler=
+generator also guesses this from your Git configuration. This is
+displayed by =gem list --details= and on rubygems.org.
+
+*** Files
+
+The quickest way to add more files is to =git add= them. Jeweler uses
+your Git repository to populate your gem's files by including added and
+committed and excluding =.gitignore=d. In most cases, this is reasonable
+enough.
+
+If you need to tweak the files, that's cool. Jeweler populates
+=gem.files= as a =Rake::FileList=. It's like a normal array, except you
+can =include= and =exclude= file globs:
+
+#+BEGIN_EXAMPLE
+    gem.files.exclude 'tmp' # exclude temporary directory
+    gem.files.include 'lib/foo/bar.rb' # explicitly include lib/foo/bar.rb
+#+END_EXAMPLE
+
+If that's not enough, you can just set =gem.files= outright
+
+#+BEGIN_EXAMPLE
+    gem.files = Dir.glob('lib/**/*.rb')
+#+END_EXAMPLE
+
+*** Dependencies
+
+Dependencies let you define other gems that your gem needs to function.
+=gem install your-gem= will install your-gem's dependencies along with
+it, and when you use your-gem in an application, the dependencies will
+be made available. Use =gem.add_dependency= to register them.
+[[http://guides.rubygems.org/specification-reference/#add_development_dependency][Reference]]
+
+#+BEGIN_EXAMPLE
+    gem.add_dependency 'nokogiri'
+#+END_EXAMPLE
+
+This will ensure a version of =nokogiri= is installed, but it doesn't
+require anything more than that. You can provide extra args to be more
+specific:
+
+#+BEGIN_EXAMPLE
+    gem.add_dependency 'nokogiri', '= 1.2.1' # exactly version 1.2.1
+    gem.add_dependency 'nokogiri', '>= 1.2.1' # greater than or equal to 1.2.1, ie, 1.2.1, 1.2.2, 1.3.0, 2.0.0, etc
+    gem.add_dependency 'nokogiri', '>= 1.2.1', '< 1.3.0' # greater than or equal to 1.2.1, but less than 1.3.0
+    gem.add_dependency 'nokogiri', '~> 1.2.1' # same thing, but more concise
+#+END_EXAMPLE
+
+When specifying which version is required, there's a bit of the
+condunrum. You want to allow the most versions possible, but you want to
+be sure they are compatible. Using =>= 1.2.1= is fine most of the time,
+except until the point that 2.0.0 comes out and totally breaks backwards
+the API. That's when it's good to use =~> 1.2.1=, which requires any
+version in the =1.2= family, starting with =1.2.1=.
+
+*** Executables
+
+Executables let your gem install shell commands. Just put any executable
+scripts in the =bin/= directory, make sure they are added using =git=,
+and Jeweler will take care of the rest.
+
+When you need more finely grained control over it, you can set it
+yourself:
+
+#+BEGIN_EXAMPLE
+    gem.executables = ['foo'] # note, it's the file name relative to `bin/`, not the project root
+#+END_EXAMPLE
+
+*** Versioning
+
+We discussed earlier how to bump the version. The rake tasks are really
+just convience methods for manipulating the =VERSION= file. It just
+contains a version string, like =1.2.3=.
+
+=VERSION= is a convention used by Jeweler, and is used to populate
+=gem.version=. You can actually set this yourself, and Jeweler won't try
+to override it:
+
+#+BEGIN_EXAMPLE
+    gem.version = '1.2.3'
+#+END_EXAMPLE
+
+A common pattern is to have this in a version constant in your library.
+This is convenient, because users of the library can query the version
+they are using at runtime.
+
+#+BEGIN_EXAMPLE
+    # in lib/foo/version.rb
+    class Foo
+      module Version
+        MAJOR = 1
+        MINOR = 2
+        PATCH = 3
+        BUILD = 'pre3'
+
+        STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+      end
+    end
+
+    # in Rakefile
+    require 'jeweler'
+    require './lib/foo/version.rb'
+    Jeweler::Tasks.new do |gem|
+      # snip
+      gem.version = Foo::Version::STRING
+    end
+#+END_EXAMPLE
+
+*** Rake tasks
+
+Jeweler lives inside of Rake. As a result, they are dear friends. But,
+that friendship doesn't interfere with typical Rake operations.
+
+That means you can define your own namespaces, tasks, or use third party
+Rake libraries without cause for concern.
+
+** Contributing to Jeweler
+
+-  Check out the latest master to make sure the feature hasn't been
+   implemented or the bug hasn't been fixed yet
+-  Ask on the [[http://groups.google.com/group/jeweler-rb][mailing
+   list]] for feedback on your proposal, to see if somebody else has
+   done it.
+-  Check out the
+   [[http://github.com/technicalpickles/jeweler/issues][issue tracker]]
+   to make sure someone already hasn't requested it and/or contributed
+   it
+-  Fork the project
+-  Start a feature/bugfix branch
+-  Commit and push until you are happy with your contribution
+-  Make sure to add tests for the feature/bugfix. This is important so I
+   don't break it in a future version unintentionally.
+-  Please try not to mess with the Rakefile, version, or history. If you
+   want to have your own version, or is otherwise necessary, that is
+   fine, but please isolate it to its own commit so I can cherry-pick
+   around it.
+
+** Copyright
+
+Copyright (c) 2008-2010 Josh Nichols. Copyright (c) 2016 Fred Mitchell.
+See LICENSE for details.