raygun 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53fef6c89e692472bd5d1bdca79c821116c57bcc
-  data.tar.gz: 7f94124fd48ae4286dc162f25705c7f5a3dbeb26
+  metadata.gz: 065ecc2e84bd97c90297b39a7619a0a6ca2aeb3e
+  data.tar.gz: cb6eb42d11c58ffff33c9a46b4e786a77b16875b
 SHA512:
-  metadata.gz: 1ebcc79eef641dfb5449169f6cbc04a0eccf13586b1907c79dc537fbeb922140331134a6b35702bf25f9f632c85d057394c3796e156cbbe1bdfd55d2649d8ae4
-  data.tar.gz: 2ee3e7c2fc6944293daa3d6b3a24feebd31cdb1f58ff0ea3125acac6a6e44723913de5288ca7921c1f7ccc5d8997415b01dd08611e4fbdad16efdbb58f2b5576
+  metadata.gz: 37cf514bd395889660bb53a7c60e6f9c706e13609a762be7b1382228f09680021ef52423986e3d30e518116c7334c2a34327fa14743cc6147dc2995babf544ce
+  data.tar.gz: 6edf23596a25b0b12aa6cab27557dae283b03ca67a2038e61370b2a2b25c2c4cd71b73698b14dda5b1cda7e26a82d44571787e7d7c1c079868eb7cabfe345b70

data/.ruby-version

@@ -1 +1 @@
-2.2.4
+2.4.2

data/CHANGES.md

@@ -1,5 +1,14 @@
 # Change Log
 
+**Note:** Don't let the apparent lack of activity here scare you away. Almost all changes are captured in the
+prototype repo (see [raygun-rails](https://github.com/carbonfive/raygun-rails)), and it's kept pretty well up to date.
+
+## 1.0.3 [2017-10-25]
+
+* Add ability to pull template repository by branch name (#137, thanks @bunnymatic!).
+* Updates to the README (mostly tweaks).
+* Use Ruby 2.4.2 for development.
+
 ## 1.0.1 [2015-01-30]
 
 * Simplify instructions: use ./bin/setup instead of explicit commands.

data/README.md

@@ -6,7 +6,7 @@
 Rails application generator that builds a new project skeleton configured with Carbon Five preferences and
 best practices baked right in. Spend less time configuring and more building cool features.
 
-Raygun generates Rails 4 projects by copying this [sample app](https://github.com/carbonfive/raygun-rails)
+Raygun generates Rails projects by copying this [sample app](https://github.com/carbonfive/raygun-rails)
 and massaging it gently into shape.
 
 Alternatively, Raygun allows you to specify your own prototype instead of the default sample app. See below
@@ -20,10 +20,9 @@ Major tools/libraries:
 * Sass
 * Bootstrap
 * RSpec
-* Factory Girl
-* Jasmine
+* Factory Bot
 * SimpleCov
-* Guard (rspec, jasmine, livereload)
+* Guard (rspec, livereload)
 * And many tweaks, patterns and common recipes (see [raygun-rails](https://github.com/carbonfive/raygun-rails) for all the details).
 
 Raygun includes generator templates for controllers, views, and specs so that generated code follows best
@@ -47,21 +46,21 @@ Raygun...
 
 ## Prerequisites
 
-To generate an application, you only need the raygun gem and network connectivity.
+To generate an application, you only need the Raygun gem and network connectivity.
 
 To run your new application's specs or fire up its server, you'll need to meet these requirements.
 
-* PostgreSQL 9.x with superuser 'postgres' with no password (```createuser -s postgres```)
-* PhantomJS for JavaScript testing (```brew install phantomjs```)
+* PostgreSQL 9.x with superuser 'postgres' with no password (`createuser -s postgres`)
+* PhantomJS for JavaScript testing (`brew install phantomjs`)
 
-The generated app will be configured to use the ruby version that was used to invoke raygun. If you're using
-another ruby, just change the ```Gemfile``` and ```.ruby-version``` as necessary.
+The generated app will be configured to use the ruby version that was used to invoke Raygun. If you're using
+another ruby, just change the `Gemfile` and `.ruby-version` as necessary.
 
 ## Usage
 
     $ raygun your-project
 
-Once your project is baked out, you can easily kick the wheels. Be sure that you have the prerequities
+Once your project is baked out, you can easily kick the wheels. Be sure that you have the prerequisites
 covered (see above).
 
     $ cd your-project
@@ -77,27 +76,33 @@ covered (see above).
 ## Using a Custom Project Template
 
 The default is to use the project at [carbonfive/raygun-rails](https://github.com/carbonfive/raygun-rails) as a
-starting point. You can use another repo as the project template with the ```-p``` command line option.
+starting point. You can use another repo as the project template with the `-p` command line option.
 
-If you invoke raygun with the ```-p``` option, you can specify your own github repository.
+If you invoke raygun with the `-p` option, you can specify your own github repository.
 
     $ raygun -p githubid/repo your-project
 
+Or 
+
+    $ raygun -p githubid/repo your-project#new-branch-name
+
 The repository must:
 
-* Have been tagged. Raygun chooses the "greatest" tag and downloads the repository as of that tag.
-* Not have any binary files. Raygun runs a 'sed' command on all files, which will fail on binaries, such as jar files.
+Not have any binary files. Raygun runs a 'sed' command on all files, which will fail on binaries, such as jar files.
+
+If you are not planning to pull the prototype repository by branch, it must also have a tag. Raygun will choose the
+"greatest" tag and downloads the repository as of that tag.
 
-If your project template requires a minimum version of raygun, include the version in a file called
-```.raygun-version``` at the root. Raygun will make sure it's new enough for your repo.
+If your project template requires a minimum version of Raygun, include the version in a file called
+`.raygun-version` at the root. Raygun will make sure it's new enough for your repo.
 
 ## Internal Mechanics
 
 Raygun fetches the greatest tag from the [carbonfive/raygun-rails](https://github.com/carbonfive/raygun-rails)
-repo, unless it already has it cached in ~/.raygun, extracts the contents of the tarball, and runs a series of
+repo, unless it already has it cached in `~/.raygun`, extracts the contents of the tarball, and runs a series of
 search-and-replaces on the code to customize it accordingly.
 
-This approach is fast, simple, and makes raygun developement very easy. Make changes to the application
+This approach is fast, simple, and makes developmentn on Raygun very easy: make changes to the application
 prototype (which is a valid rails app) and tag them when they should be used for new applications.
 
 ## Contributing
@@ -110,7 +115,7 @@ prototype (which is a valid rails app) and tag them when they should be used for
 
 ### Development
 
-Generate an example app using your local development version of raygun:
+Generate an example app using your local development version of Raygun:
 
     $ ./bin/raygun tmp/example_app
 

data/lib/raygun/raygun.rb

@@ -7,6 +7,7 @@ require 'json'
 require 'colorize'
 
 require_relative 'version'
+require_relative 'template_repo'
 
 module Raygun
   class Runner
@@ -45,15 +46,16 @@ module Raygun
       $stdout.flush
 
       # Check if we can connect, or fail gracefully and use the latest cached version.
-      latest_tag_obj = fetch_latest_tag(prototype_repo)
-      latest_tag     = latest_tag_obj['name']
-      tarball_url    = latest_tag_obj['tarball_url']
+      repo        = TemplateRepo.new(prototype_repo)
+      name        = repo.name
+      tarball_url = repo.tarball
+      sha         = repo.sha
 
-      print " #{latest_tag}.".colorize(:white)
+      print " #{name}.".colorize(:white)
       $stdout.flush
 
       cached_prototypes_dir = File.join(Dir.home, ".raygun")
-      @prototype = "#{cached_prototypes_dir}/#{prototype_repo.sub('/', '--')}-#{latest_tag}.tar.gz"
+      @prototype = "#{cached_prototypes_dir}/#{name.gsub('/','--')}-#{sha}.tar.gz"
 
       # Do we already have the tarball cached under ~/.raygun?
       if File.exists?(@prototype)
@@ -64,7 +66,6 @@ module Raygun
 
         # Download the tarball and install in the cache.
         Dir.mkdir(cached_prototypes_dir, 0755) unless Dir.exists?(cached_prototypes_dir)
-
         shell "curl -s -L #{tarball_url} -o #{@prototype}"
         puts " done!".colorize(:yellow)
       end
@@ -176,7 +177,7 @@ module Raygun
         print_next_steps_for_custom_repo
       end
     end
-    
+
     def print_next_steps_carbon_five
       puts ""
       puts "Zap! Your application is ready. Next steps...".colorize(:yellow)
@@ -194,7 +195,7 @@ module Raygun
       puts ""
       puts "Enjoy your Carbon Five flavored Rails application!".colorize(:yellow)
     end
-    
+
     def print_next_steps_for_custom_repo
       puts ""
       puts "Zap! Your application is ready.".colorize(:yellow)
@@ -204,51 +205,6 @@ module Raygun
 
     protected
 
-    # Fetch the tags for the repo (e.g. 'carbonfive/raygun-rails') and return the latest as JSON.
-    def fetch_latest_tag(repo)
-      url          = "https://api.github.com/repos/#{repo}/tags"
-      uri          = URI.parse(url)
-      http         = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
-      request      = Net::HTTP::Get.new(URI.encode(url))
-
-      response     = http.request(request)
-
-      unless response.code == "200" 
-        puts  ""
-        print "Whoops - need to try again!".colorize(:red)
-        puts  ""
-        print "We could not find (".colorize(:light_red)
-        print "#{repo}".colorize(:white)
-        print ") on github.".colorize(:light_red)
-        puts  ""
-        print "The response from github was a (".colorize(:light_red)
-        print "#{response.code}".colorize(:white)
-        puts  ") which I'm sure you can fix right up!".colorize(:light_red)
-        puts  ""
-        exit 1
-      end
-
-      result = JSON.parse(response.body).first
-      unless result
-        puts  ""
-        print "Whoops - need to try again!".colorize(:red)
-        puts  ""
-        print "We could not find any tags in the repo (".colorize(:light_red)
-        print "#{repo}".colorize(:white)
-        print ") on github.".colorize(:light_red)
-        puts  ""
-        print "Raygun uses the 'largest' tag in a repository, where tags are sorted alphanumerically.".colorize(:light_red)
-        puts  ""
-        print "E.g., tag 'v.0.10.0' > 'v.0.9.9' and 'x' > 'a'.".colorize(:light_red)
-        print ""
-        puts  ""
-        exit 1
-      end
-      
-      result
-    end
-
     def camelize(string)
       result = string.sub(/^[a-z\d]*/) { $&.capitalize }
       result.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }

data/lib/raygun/template_repo.rb

@@ -0,0 +1,76 @@
+module Raygun
+  class TemplateRepo
+    attr_reader :name, :branch, :tarball, :sha
+
+    def initialize(repo)
+      @name, @branch = repo.split('#').map(&:strip)
+      fetch
+    end
+
+    private
+
+    def fetch
+      return if @branch && @sha
+      @branch ? fetch_branches : fetch_tags
+    end
+
+    def handle_github_error(response)
+      puts  ""
+      print "Whoops - need to try again!".colorize(:red)
+      puts  ""
+      print "We could not find (".colorize(:light_red)
+      print "#{name}".colorize(:white)
+      print "##{branch}".colorize(:white) if @branch
+      print ") on github.".colorize(:light_red)
+      puts  ""
+      print "The response from github was a (".colorize(:light_red)
+      print "#{response.code}".colorize(:white)
+      puts  ") which I'm sure you can fix right up!".colorize(:light_red)
+      puts  ""
+      exit 1
+    end
+
+    def handle_missing_tag_error
+      puts  ""
+      print "Whoops - need to try again!".colorize(:red)
+      puts  ""
+      print "We could not find any tags in the repo (".colorize(:light_red)
+      print "#{name}".colorize(:white)
+      print ") on github.".colorize(:light_red)
+      puts  ""
+      print "Raygun uses the 'largest' tag in a repository, where tags are sorted alphanumerically.".colorize(:light_red)
+      puts  ""
+      print "E.g., tag 'v.0.10.0' > 'v.0.9.9' and 'x' > 'a'.".colorize(:light_red)
+      print ""
+      puts  ""
+      exit 1
+    end
+
+    def fetch_branches
+      response = http_get("https://api.github.com/repos/#{name}/branches/#{branch}")
+      handle_github_error(response) unless response.code == "200"
+      result = JSON.parse(response.body)
+      @sha = result['commit']['sha']
+      @tarball = result['_links']['html'].gsub(%r(/tree/#{branch}), "/archive/#{branch}.tar.gz")
+    end
+
+    def fetch_tags
+      response = http_get("https://api.github.com/repos/#{name}/tags")
+      handle_github_error(response) unless response.code == "200"
+
+      result = JSON.parse(response.body).first
+      handle_missing_tag_error unless result
+      @sha = result['commit']['sha']
+      @tarball = result['tarball_url']
+    end
+
+    def http_get(url)
+      uri          = URI.parse(url)
+      http         = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      request      = Net::HTTP::Get.new(URI.encode(url))
+
+      response     = http.request(request)
+    end
+  end
+end

data/lib/raygun/version.rb

@@ -1,3 +1,3 @@
 module Raygun
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raygun
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Christian Nelson
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-31 00:00:00.000000000 Z
+date: 2017-10-25 00:00:00.000000000 Z
 dependencies: []
 description: Carbon Five Rails application generator
 email:
@@ -31,6 +31,7 @@ files:
 - bin/raygun
 - lib/colorize.rb
 - lib/raygun/raygun.rb
+- lib/raygun/template_repo.rb
 - lib/raygun/version.rb
 - marvin.jpg
 - raygun.gemspec
@@ -54,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Generates and customizes Rails applications with Carbon Five best practices