rails_finder 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_finder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris Thorn
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# RailsFinder
+
+Finds Rails applications in a given directory and reports their version numbers.
+
+Currently, I maintain quite a lot of Rails applications, and the recent flux of
+security vulnerabilities left me wanting something a little more than one-off
+shell scripts. I also felt like hacking on some Ruby that wasn't Rails, as it's
+been a while since I've been able to. It felt good.
+
+## Installation
+
+    gem install rails_finder
+
+## Usage
+
+To search in the current directory
+
+    $ find_rails
+
+To specify a directory
+
+    $ find_rails path_to_search
+
+Example
+
+    $ find_rails ~/code
+    the-oldtimer      2.3.16   /Users/chris/code/the-oldtimer
+    the-outlier       3.2      /Users/chris/code/the-outlier
+    the-good-one      3.2.11   /Users/chris/code/the-good-one
+    wat               4.0.0    /Users/chris/code/wat
+    templates         n/a      /Users/chris/code/rails/railties/lib/rails/generators/rails/app/templates
+
+## Limitations
+
+* Only the Gemfile and config/environments.rb files are inspected. If the
+  version specified there is not the installed version, then the report will be
+  inaccurate. For example: `~> 3.2` will be reported as "3.2" regardless of the
+  installed version.
+
+* The recursive search will pick up config files of dummy applications that are
+  only used for testing.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/find_rails

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require "rails_finder"
+
+def print_help
+  puts <<END
+Finds Rails applications in the given directory and reports their
+version numbers. If no directory is given, uses the current.
+END
+  puts "\n\tusage: find_rails [directory]"
+end
+
+if ARGV.any? { |a| a == "-h" || a == "--help" }
+  print_help
+  exit
+end
+
+RailsFinder.run(ARGV.first || Dir.pwd)

data/lib/rails_finder/app.rb

@@ -0,0 +1,36 @@
+require "rails_finder/gemfile"
+require "rails_finder/environment_file"
+
+module RailsFinder
+  class App
+    attr_reader :root
+
+    def initialize(root)
+      @root = root
+    end
+
+    def basename
+      File.basename(root)
+    end
+
+    def rails_version
+      if gemfile.exists?
+        gemfile.rails_version
+      elsif envfile.exists?
+        envfile.rails_version
+      else
+        "n/a"
+      end
+    end
+
+    private
+
+    def gemfile
+      @gemfile ||= Gemfile.new(File.join(root, "Gemfile"))
+    end
+
+    def envfile
+      @envfile ||= EnvironmentFile.new(File.join(root, "config", "environment.rb"))
+    end
+  end
+end

data/lib/rails_finder/environment_file.rb

@@ -0,0 +1,24 @@
+module RailsFinder
+  class EnvironmentFile
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def exists?
+      File.exists?(path)
+    end
+
+    def rails_version
+      return @rails_version if @rails_version
+
+      version_line = File.readlines(path).find { |l| l =~ /RAILS_GEM_VERSION/ }
+      if version_line
+        @rails_version = version_line[/\d+\.\d+(\.\d+)?/].strip
+      else
+        @rails_version = "n/a"
+      end
+    end
+  end
+end

data/lib/rails_finder/gemfile.rb

@@ -0,0 +1,23 @@
+module RailsFinder
+  class Gemfile
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def exists?
+      File.exists?(path)
+    end
+
+    def rails_version
+      return @rails_version if @rails_version
+      line = File.readlines(path).find { |l| l =~ /^gem.+rails/i }
+      if line
+        @rails_version = line[/\d+\.\d+(\.\d+)?/]
+      else
+        @rails_version = "n/a"
+      end
+    end
+  end
+end

data/lib/rails_finder/version.rb

@@ -0,0 +1,3 @@
+module RailsFinder
+  VERSION = "0.0.1"
+end

data/lib/rails_finder.rb

@@ -0,0 +1,43 @@
+require "rails_finder/version"
+require "rails_finder/app"
+
+module RailsFinder
+  def self.run(dir, output = $stdout)
+    Runner.new(dir, output).print
+  end
+
+  class Runner
+    attr_reader :dir, :output
+
+    def initialize(dir, output = $stdout)
+      @dir = dir
+      @output = output
+    end
+
+    def print
+      if apps.any?
+        apps.sort_by(&:rails_version).each do |app|
+          output.puts "#{app.basename.ljust(root_width)} #{app.rails_version.ljust(version_width)} #{app.root}"
+        end
+      else
+        output.puts "none found"
+      end
+    end
+
+    def apps
+      @apps ||= Dir["#{dir}/**/config/environment.rb"].map do |file|
+        App.new(File.expand_path("../..", file))
+      end
+    end
+
+    private
+
+    def root_width
+      @root_label_width = (apps.map { |a| a.basename.length }.max || 0) + 2
+    end
+
+    def version_width
+      @version_width ||= (apps.map { |a| a.rails_version.length }.max || 0)+ 2
+    end
+  end
+end

data/rails_finder.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_finder/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rails_finder"
+  gem.version       = RailsFinder::VERSION
+  gem.authors       = ["Chris Thorn"]
+  gem.email         = ["thorncp@gmail.com"]
+  gem.description   = %q{Overly simple utility to recursively find Rails apps and their versions}
+  gem.summary       = %q{Overly simple utility to recursively find Rails apps and their versions}
+  gem.homepage      = "https://github.com/thorncp/rails_finder"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec", "~> 2.12.0"
+end

data/spec/rails_finder/app_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+require "rails_finder/app"
+
+module RailsFinder
+  describe App do
+    it "knows path basname" do
+      with_dir do |dir|
+        path = File.join(dir, "awesome_app")
+        Dir.mkdir(path)
+        App.new(path).basename.should == "awesome_app"
+      end
+    end
+
+    it "reports Rails version from Gemfile" do
+      subject = App.new(stub)
+      subject.stub(gemfile: stub(exists?: true, rails_version: "3.2.11"))
+      subject.stub(envfile: stub(exists?: true, rails_version: "n/a"))
+      subject.rails_version.should == "3.2.11"
+    end
+
+    it "reports Rails version from environment file" do
+      subject = App.new(stub)
+      subject.stub(gemfile: stub(exists?: false, rails_version: "n/a"))
+      subject.stub(envfile: stub(exists?: true, rails_version: "2.3.16"))
+      subject.rails_version.should == "2.3.16"
+    end
+
+    it "reports n/a when no Rails version is found" do
+      subject = App.new(stub)
+      subject.stub(gemfile: stub(exists?: false))
+      subject.stub(envfile: stub(exists?: false))
+      subject.rails_version.should == "n/a"
+    end
+  end
+end

data/spec/rails_finder/environment_file_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+require "rails_finder/environment_file"
+require "tmpdir"
+require "fileutils"
+
+VALID_ENVFILE = <<END
+RAILS_GEM_VERSION = '2.3.16' unless defined? RAILS_GEM_VERSION
+
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  config.time_zone = 'Pacific Time (US & Canada)'
+	config.cache_store = :mem_cache_store
+end
+END
+
+
+module RailsFinder
+  describe EnvironmentFile do
+    it "knows if file exists" do
+      with_dir do |dir|
+        FileUtils.touch(envfile(dir))
+        EnvironmentFile.new(envfile(dir)).should exist
+      end
+    end
+
+    it "knows if file does not exist" do
+      with_dir do |dir|
+        EnvironmentFile.new(envfile(dir)).should_not exist
+      end
+    end
+
+    it "reports Rails version" do
+      with_dir do |dir|
+        File.open(envfile(dir), "w") do |file|
+          file.puts(VALID_ENVFILE)
+        end
+
+        EnvironmentFile.new(envfile(dir)).rails_version.should == "2.3.16"
+      end
+    end
+
+    it "reports none when no Rails version" do
+      with_dir do |dir|
+        File.open(envfile(dir), "w") do |file|
+          file.puts "require File.expand_path('../application', __FILE__)"
+          file.puts "Recipes::Application.initialize!"
+        end
+
+        EnvironmentFile.new(envfile(dir)).rails_version.should == "n/a"
+      end
+    end
+
+    it "memoizes rails version" do
+      with_dir do |dir|
+        File.open(envfile(dir), "w") do |file|
+          file.puts(VALID_ENVFILE)
+        end
+
+        @subject = EnvironmentFile.new(envfile(dir))
+        @subject.rails_version.should == "2.3.16"
+      end
+
+      @subject.rails_version.should == "2.3.16"
+    end
+  end
+end

data/spec/rails_finder/gemfile_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+require "rails_finder/gemfile"
+require "tmpdir"
+require "fileutils"
+
+VALID_GEMFILE = <<END
+source :rubygems
+
+gem "rails", "3.2.11"
+gem "jquery-rails"
+END
+
+module RailsFinder
+  describe Gemfile do
+    it "knows if file exists" do
+      with_dir do |dir|
+        FileUtils.touch(gemfile(dir))
+
+        Gemfile.new(gemfile(dir)).should exist
+      end
+    end
+
+    it "knows if file does not exist" do
+      with_dir do |dir|
+        Gemfile.new(gemfile(dir)).should_not exist
+      end
+    end
+
+    it "reports Rails version" do
+      with_dir do |dir|
+        File.open(gemfile(dir), "w") do |file|
+          file.puts(VALID_GEMFILE)
+        end
+
+        Gemfile.new(gemfile(dir)).rails_version.should == "3.2.11"
+      end
+    end
+
+    it "reports none when no Rails version" do
+      with_dir do |dir|
+        File.open(gemfile(dir), "w") do |file|
+          file.puts "source :rubygems"
+          file.puts "gem 'rspec', '2.12.0'"
+        end
+
+        Gemfile.new(gemfile(dir)).rails_version.should == "n/a"
+      end
+    end
+
+    it "memoizes rails version" do
+      with_dir do |dir|
+        File.open(gemfile(dir), "w") do |file|
+          file.puts(VALID_GEMFILE)
+        end
+
+        @subject = Gemfile.new(gemfile(dir))
+        @subject.rails_version.should == "3.2.11"
+      end
+
+      @subject.rails_version.should == "3.2.11"
+    end
+  end
+end

data/spec/rails_finder_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+require "rails_finder"
+require "tmpdir"
+require "fileutils"
+
+VALID_GEMFILE = <<END
+source :rubygems
+
+gem 'rails', '3.2.11'
+gem 'jquery-rails'
+gem 'sqlite3'
+
+group :development, :test do
+  gem 'rspec', '~> 2.12'
+end
+END
+
+VALID_2_3_ENVIRONMENT_FILE = <<END
+RAILS_GEM_VERSION = '2.3.16' unless defined? RAILS_GEM_VERSION
+
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  config.time_zone = 'Pacific Time (US & Canada)'
+	config.cache_store = :mem_cache_store
+end
+END
+
+describe RailsFinder do
+  it "finds and reports on valid Gemfile" do
+    Dir.mktmpdir "rails_finder-valid_app" do |dir|
+      FileUtils.mkdir_p(File.join(dir, "config"))
+      FileUtils.touch(File.join(dir, "config", "environment.rb"))
+      File.open(File.join(dir, "Gemfile"), "w") do |file|
+        file.puts(VALID_GEMFILE)
+      end
+
+      out = StringIO.new
+      RailsFinder.run(dir, out)
+      out.string.should include "3.2.11"
+      out.string.should include "rails_finder-valid_app"
+    end
+  end
+
+  it "finds and reports on valid 2.3 environment file" do
+    Dir.mktmpdir "valid_2.3_app" do |dir|
+      FileUtils.mkdir_p(File.join(dir, "config"))
+      File.open(File.join(dir, "config", "environment.rb"), "w") do |file|
+        file.puts(VALID_2_3_ENVIRONMENT_FILE)
+      end
+
+      out = StringIO.new
+      RailsFinder.run(dir, out)
+      out.string.should include "2.3.16"
+      out.string.should include "valid_2.3_app"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require "rails_finder"
+require "fileutils"
+require "tmpdir"
+
+RSpec.configure do |config|
+  def with_dir
+    Dir.mktmpdir("rails_version-spec") do |dir|
+      FileUtils.mkdir_p(File.join(dir, "config"))
+      yield dir
+    end
+  end
+
+  def gemfile(dir)
+    File.join(dir, "Gemfile")
+  end
+
+  def envfile(dir)
+    File.join(dir, "config", "environment.rb")
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: rails_finder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Thorn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: Overly simple utility to recursively find Rails apps and their versions
+email:
+- thorncp@gmail.com
+executables:
+- find_rails
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/find_rails
+- lib/rails_finder.rb
+- lib/rails_finder/app.rb
+- lib/rails_finder/environment_file.rb
+- lib/rails_finder/gemfile.rb
+- lib/rails_finder/version.rb
+- rails_finder.gemspec
+- spec/rails_finder/app_spec.rb
+- spec/rails_finder/environment_file_spec.rb
+- spec/rails_finder/gemfile_spec.rb
+- spec/rails_finder_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/thorncp/rails_finder
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Overly simple utility to recursively find Rails apps and their versions
+test_files:
+- spec/rails_finder/app_spec.rb
+- spec/rails_finder/environment_file_spec.rb
+- spec/rails_finder/gemfile_spec.rb
+- spec/rails_finder_spec.rb
+- spec/spec_helper.rb