railsapp_factory 0.0.1

data/spec/railsapp_factory/helper_methods_spec.rb

@@ -0,0 +1,124 @@
+require 'rspec'
+
+require 'railsapp_factory/class_methods'
+require 'railsapp_factory/helper_methods'
+
+describe 'RailsappFactory::ClassMethods' do
+
+  class SubjectClass
+    extend RailsappFactory::ClassMethods
+    include RailsappFactory::HelperMethods
+
+    # from server_methods
+    attr_accessor :port, :pid
+
+    # from RunInAppMethods
+    attr_accessor :using
+
+  end
+
+  subject { SubjectClass.new }
+
+  describe "#uri" do
+    before do
+      subject.port = 123
+    end
+
+    it "should return a URI" do
+      subject.uri('/a/path').should be_a_kind_of(URI)
+    end
+    it "should be for 127.0.0.1" do
+      subject.uri('/a/path').to_s.should start_with('http://127.0.0.1:123/')
+    end
+    it "should end in given path" do
+      subject.uri('/a/path').to_s.should end_with('/a/path')
+    end
+
+  end
+
+  describe "#url" do
+    before do
+      subject.port = 567
+    end
+
+
+    it "should return a URI" do
+      subject.url('/a/path').should be_a_kind_of(String)
+    end
+    it "should be for 127.0.0.1" do
+      subject.url('/a/path').should start_with('http://127.0.0.1:567/')
+    end
+    it "should end in given path" do
+      subject.url('/a/path').should end_with('/a/path')
+    end
+
+  end
+
+
+  describe "#env=" do
+    before do
+      subject.env = 'development'
+    end
+
+    it "should set @override_ENV RAILS_ENV/RACK_ENV" do
+      subject.override_ENV['RAILS_ENV'].should == 'development'
+      subject.override_ENV['RACK_ENV'].should == 'development'
+    end
+
+    it "should be reflected in env" do
+      subject.env.test?.should be_false
+      subject.env.should be_development
+    end
+
+  end
+
+  describe "#env" do
+    it "should be test by default" do
+      subject.env.to_s.should == 'test'
+      subject.env.should be_test
+      subject.env.should_not be_development
+    end
+  end
+
+  #describe "#rubies" do
+  #
+  #  it "should return a list of rubies" do
+  #    list = subject.rubies(nil)
+  #    list.should be_a_kind_of(Array)
+  #    list.should_not be_empty
+  #  end
+  #end
+
+  describe "#alive?" do
+
+    it "should report an alive process as alive" do
+      IO.popen('cat', 'w') do |pipe|
+        subject.pid = pipe.pid
+        subject.should be_alive
+      end
+    end
+
+    it "should report a completed process as dead" do
+      IO.popen('cat', 'w') do |pipe|
+        subject.pid = pipe.pid
+      end
+      subject.should_not be_alive
+    end
+
+    it "should report nil pid as dead" do
+      subject.pid = nil
+      subject.should_not be_alive
+    end
+
+  end
+
+  describe "logger" do
+    it "has valid logger" do
+      subject.logger.should respond_to(:info, :warn, :debug, :error)
+    end
+  end
+
+
+end
+
+

data/spec/railsapp_factory/string_inquirer_spec.rb

@@ -0,0 +1,24 @@
+require 'rspec'
+
+require 'railsapp_factory/string_inquirer'
+
+describe 'RailsappFactory::StringInquirer' do
+  subject { RailsappFactory::StringInquirer.new('example_string') }
+
+  it 'should be a kind of string' do
+    subject.should be_a_kind_of(String)
+  end
+
+  it 'should equal the string it was initialized with' do
+    subject.should == 'example_string'
+  end
+
+  it 'should respond to example_string? with true' do
+    subject.example_string?.should be_true
+  end
+
+  it 'should respond to all other questions with false' do
+    subject.test?.should be_false
+  end
+
+end

data/spec/railsapp_factory/template_methods_spec.rb

@@ -0,0 +1,98 @@
+require 'rspec'
+require 'spec_helper'
+
+require 'railsapp_factory/class_methods'
+require 'railsapp_factory/template_methods'
+require 'railsapp_factory/helper_methods'
+
+describe 'RailsappFactory::TemplateMethods' do
+
+  class SubjectClass
+    extend RailsappFactory::ClassMethods
+    # include for logger
+    include RailsappFactory::HelperMethods
+    include RailsappFactory::TemplateMethods
+
+    def base_dir
+      "/tmp"
+    end
+
+    def version
+      '4.0'
+    end
+  end
+
+  subject { SubjectClass.new }
+
+  describe '#process_template' do
+    it 'should call nothing when nothing has been added' do
+      subject.process_template
+      subject.template.should be_nil
+    end
+
+    describe 'with template contents' do
+      before { subject.append_to_template('gem "one"') }
+
+      it "should have contents" do
+        subject.template.should_not be_nil
+        File.size?(subject.template).should be_true
+      end
+
+      describe "before build" do
+        before { subject.stub(:built?).and_return(false) }
+        it "should call build" do
+          subject.built?.should be_false
+          subject.should_receive(:build).with()
+          subject.process_template
+          # checked elsewhere that build clears the template
+        end
+      end
+
+      describe "when built" do
+        before { subject.stub(:built?).and_return(true) }
+        it "should call process_template" do
+          subject.should_receive(:system_in_app).and_return(true)
+          subject.process_template
+          subject.template.should be_nil
+        end
+      end
+    end
+  end
+
+
+  it '#append_to_template(text) should append text to a template' do
+    subject.append_to_template('gem "one"')
+    subject.append_to_template('gem "two"')
+    File.exist?(subject.template).should be_true
+    File.read(subject.template).should include("\ngem \"one\"\n")
+    File.read(subject.template).should include("\ngem \"two\"\n")
+  end
+
+  it '#use_template(template) should append text to a template from a local file' do
+    subject.use_template('templates/add_json_pure.rb')
+    File.exist?(subject.template).should be_true
+    File.read(subject.template).should include("\ngem 'json_pure'\n")
+  end
+
+  it '#use_template(template) should append text to a template from a remote file' do
+    subject.use_template('https://raw2.github.com/ianheggie/railsapp_factory/master/spec/templates/add-file.rb')
+    File.exist?(subject.template).should be_true
+    File.read(subject.template).should include("file.txt")
+  end
+
+  it 'should merge the contents of multiple appends and use_template calls' do
+    subject.append_to_template('gem "one"')
+    subject.use_template('templates/add_json_pure.rb')
+    subject.append_to_template('gem "two"')
+    subject.use_template('https://raw2.github.com/ianheggie/railsapp_factory/master/spec/templates/add-file.rb')
+    File.exist?(subject.template).should be_true
+    File.read(subject.template).should include("\ngem \"one\"\n")
+    File.read(subject.template).should include("\ngem \"two\"\n")
+    File.read(subject.template).should include("\ngem 'json_pure'\n")
+    File.read(subject.template).should include("file.txt")
+  end
+
+
+end
+
+

data/spec/railsapp_factory_spec.rb

@@ -0,0 +1,387 @@
+require 'rspec'
+require 'spec_helper'
+require 'net/http'
+
+require 'railsapp_factory'
+
+describe 'RailsappFactory' do
+
+  # order by number at start of the description and then by random
+  # note 'describe' groups always sort after 'it' examples
+  RSpec.configure do |config|
+    config.order_groups_and_examples do |list|
+      list.sort_by { |item| [item.description.sub(/^(\d*).*/, '\1').to_i, rand] }
+    end
+  end
+
+  before(:all) do
+    puts '(before(:all) doing cleanup: rm -rf tmp/railsapp)'
+    RailsappFactory.cleanup
+  end
+
+  shared_examples_for RailsappFactory do
+
+    it "A RUBY VERSION MANAGER MUST BE MADE AVAILABLE!!" do
+      RailsappFactory.has_ruby_version_manager?.should be_true
+    end
+
+    describe "Ruby version manager" do
+      before do
+        # TODO: put back rubies(nil) when I get it working
+        @ruby_vs = RailsappFactory.rubies().collect {|s| s.sub(/.*?(\d+\.\d+\.\d+).*/, '\1')}
+      end
+
+      it 'must have ruby 1.8.7' do
+        @ruby_vs.should include('1.8.7')
+      end
+
+      it 'must have ruby 1.9.3' do
+        @ruby_vs.should include('1.9.3')
+      end
+
+    end
+
+    #unless RailsappFactory.has_ruby_version_manager?
+    #  it 'should suggest rubies that can be used with this rails version' do
+    #    list = @factory.rubies
+    #    list.should be_a_kind_of(Array)
+    #    list.should_not be_empty
+    #  end
+    #
+    #end
+
+    it '#use should set using' do
+      fake_version = '3.14.159'
+      @factory.using.should == ''
+      @factory.use(fake_version)
+      @factory.using.should == fake_version
+      @factory.use(nil)
+      @factory.using.should == ''
+    end
+
+    it '#use should accept a block and only set using within it' do
+      fake_version = '3.14.159'
+      @factory.using.should == ''
+      ran_block = false
+      @factory.use(fake_version) do
+        @factory.using.should == fake_version
+        ran_block = true
+      end
+      ran_block.should == true
+      @factory.using.should == ''
+    end
+
+    it 'new should not build the application' do
+      @factory.should_not be_built
+    end
+
+    it 'should pick an appropriate version' do
+      if @factory.version =~ /2.3-lts/
+        @factory.release.should == '2.3.18'
+      else
+        @factory.release.should match(/^#{@factory.version}\./)
+      end
+    end
+
+    describe '2: when built using #build with templates' do
+      include SpecHelper
+
+      before(:all) do
+        @factory.use_template('spec/templates/add-ruby_version-controller.rb')
+        @factory.use_template('spec/templates/add-file.rb')
+        @factory.build
+      end
+
+      it '#built? should be true' do
+        @factory.should be_built
+      end
+
+      it 'a rails app should have been installed at root' do
+        Dir.chdir(@factory.root) do
+          Kernel.system 'find . -print | sort'
+          expected = %w{ app config db lib log public test tmp }
+          have = expected.select { |d| File.directory?(d) }
+          have.should == expected
+          expected = %w{app/controllers/application_controller.rb
+                        config/database.yml config/environment.rb config/routes.rb  }
+          have = expected.select { |fn| File.exists?(fn) }
+          have.should == expected
+        end
+      end
+
+      it 'it should have gems installed by bundler' do
+        Dir.chdir(@factory.root) do
+          expected = %w{ Gemfile Gemfile.lock }
+          have = expected.select { |fn| File.exists?(fn) }
+          have.should == expected
+        end
+      end
+
+      it 'the first template should have been processed' do
+        file = File.join(@factory.root, 'app/controllers/ruby_version_controller.rb')
+        File.exists?(file).should be_true
+        File.open(file).read.should =~ /RUBY_VERSION/
+      end
+
+      it 'the 2nd template should have been processed' do
+        file = File.join(@factory.root, 'public/file.txt')
+        File.exists?(file).should be_true
+        File.open(file).read.should =~ /a short poem/
+      end
+
+      it 'the template should have been cleared' do
+        @factory.template.should be_nil
+      end
+
+      it 'shell_eval should return stdout' do
+        @factory.shell_eval('date').should =~ /\d\d:\d\d/
+        @factory.shell_eval('env').should =~ /PATH=/
+      end
+
+      it 'RAILS_ENV should be set to test' do
+        @factory.env.should be_test
+        @factory.env.to_s.should == 'test'
+        @factory.shell_eval('echo $RAILS_ENV').should == "test\n"
+        @factory.shell_eval('echo $RACK_ENV').should == "test\n"
+      end
+
+      it 'ruby_eval should handle simple values' do
+        @factory.ruby_eval('1 + 2').should == 3
+        @factory.ruby_eval("'a-' + \"string\"").should == 'a-string'
+        @factory.ruby_eval('[1, :pear]').should == [1, 'pear']
+        @factory.ruby_eval("{ 'apple' => 23 }").should == {'apple' => 23}
+      end
+
+      it 'rails_eval should report rails specific values' do
+        @factory.rails_eval('Rails.env').should == @factory.env.to_s
+      end
+
+      if RUBY_VERSION !~ /^1\.8/
+        # ruby_eval uses runner for ruby 1.8.7
+        it 'ruby_eval should not report rails specific values' do
+          lambda { @factory.ruby_eval('Rails.env') }.should raise_error(NameError)
+        end
+      end
+
+      it 'ruby_eval should try and reproduce exceptions thrown' do
+        lambda { @factory.ruby_eval('1 / 0') }.should raise_error(ZeroDivisionError)
+      end
+
+      it 'ruby_eval should handle require and multi line commands' do
+        @factory.ruby_eval("before = 123\nrequire 'cgi'\nafter = defined?(CGI)\n[before,after]").should == [123, 'constant']
+      end
+
+      it 'ruby_eval should throw argument error on syntax errors' do
+        lambda { @factory.ruby_eval('def missing_an_arg(=2); end') }.should raise_error(ArgumentError)
+      end
+
+      it 'ruby_eval allows choice of :yaml' do
+        @factory.ruby_eval('Set.new([1,2])', :yaml).should == Set.new([1, 2])
+      end
+
+      it 'ruby_eval by default uses :json which converts non simple objects to either their class name or a simple object' do
+        ret = @factory.ruby_eval('Set.new([1,2])', :json)
+        if ret.is_a? Array
+          ret.should == [1, 2]
+        else
+          ret.should be_kind_of(String)
+          ret.should match(/#<Set:0x\w+>/)
+        end
+      end
+
+      it 'override_ENV should allow arbitrary environment variables to be set' do
+        @factory.override_ENV['ARBITRARY_VAR'] = 'some value'
+        @factory.in_app do
+          ENV['ARBITRARY_VAR']
+        end.should == 'some value'
+        @factory.shell_eval('echo $ARBITRARY_VAR').should == "some value\n"
+        @factory.ruby_eval("ENV['ARBITRARY_VAR']").should == 'some value'
+        ENV['ARBITRARY_VAR'].should == nil
+      end
+
+      #unless RailsappFactory.has_ruby_version_manager?
+      #
+      #  it 'ruby_eval should work with all the rubies' do
+      #    RUBY_VERSION.should == @factory.ruby_eval('RUBY_VERSION')
+      #    @factory.rubies.each do |ruby_v|
+      #      @factory.use(ruby_v) do
+      #        actual_ruby_v = @factory.ruby_eval('RUBY_VERSION')
+      #        actual_version_should_match_rubies_version(actual_ruby_v, ruby_v, false)
+      #      end
+      #    end
+      #  end
+      #
+      #  it 'rails_eval should work with all the rubies' do
+      #    begin
+      #      RUBY_VERSION.should == @factory.ruby_eval('RUBY_VERSION')
+      #      @factory.rubies.each do |ruby_v|
+      #        @factory.use(ruby_v)
+      #        actual_ruby_v = @factory.rails_eval('RUBY_VERSION')
+      #        actual_version_should_match_rubies_version(actual_ruby_v, ruby_v, false)
+      #      end
+      #    ensure
+      #      # and nil should return to default
+      #      @factory.use(nil)
+      #      RUBY_VERSION.should == @factory.ruby_eval('RUBY_VERSION')
+      #    end
+      #  end
+      #
+      #  it 'shell_eval should work with all the rubies' do
+      #    RUBY_VERSION.should == @factory.ruby_eval('RUBY_VERSION')
+      #    @factory.rubies.each do |ruby_v|
+      #      @factory.use(ruby_v) do
+      #        actual_ruby_v = @factory.shell_eval('ruby -v')
+      #        actual_version_should_match_rubies_version(actual_ruby_v, ruby_v)
+      #      end
+      #    end
+      #  end
+      #
+      #  it 'system_in_app should work with all the rubies' do
+      #    RUBY_VERSION.should == @factory.ruby_eval('RUBY_VERSION')
+      #    @factory.rubies.each do |ruby_v|
+      #      @factory.use(ruby_v) do
+      #        tmp_filename = Tempfile.new('ruby_version').path
+      #        @factory.system_in_app("ruby -v > #{tmp_filename}")
+      #        actual_ruby_v = File.read(tmp_filename)
+      #        actual_version_should_match_rubies_version(actual_ruby_v, ruby_v)
+      #        FileUtils.rm_f tmp_filename
+      #      end
+      #    end
+      #  end
+      #end
+
+      it 'should allow templates to be processed after build' do
+        @factory.use_template('spec/templates/add-yet-another-file.rb')
+        @factory.process_template
+        @factory.template.should be_nil
+        file = File.join(@factory.root, 'public/yet-another-file.txt')
+        File.exists?(file).should be_true
+        File.open(file).read.should =~ /Lorem ipsum/
+      end
+
+      describe 'when server is run using #start' do
+        before(:all) do
+          @factory.start.should be_true
+        end
+
+        after(:all) do
+          @factory.stop
+        end
+
+        it 'start should run the application' do
+          @factory.should be_alive
+        end
+
+        it 'the application should be on a non privileged port' do
+          @factory.port.should > 1024
+        end
+
+        it 'should have a http server running on port' do
+          response = Net::HTTP.get(URI(@factory.url))
+          response.should be_an_instance_of(String)
+        end
+
+        it 'should serve static files' do
+          response = Net::HTTP.get(@factory.uri('file.txt'))
+          response.should be_an_instance_of(String)
+          response.should =~ /a short poem/
+        end
+
+        it 'should serve dynamic page: /ruby_version' do
+          response = Net::HTTP.get(@factory.uri('/ruby_version'))
+          response.should be_an_instance_of(String)
+          response.should include(RUBY_VERSION)
+        end
+
+        it 'should respond with an error for missing paths' do
+          response = Net::HTTP.get_response(@factory.uri('/no_such_path'))
+          %w{404 500}.should include(response.code)
+          response.body.should =~ /No route matches/
+        end
+
+        it '9: stop should stop the application' do
+          @factory.stop.should be_true
+          @factory.should_not be_alive
+        end
+      end
+
+      #describe "#rubies" do
+      #
+      #  # fails ruby 1.9.2 (new, 3.0, 3.1)
+      #
+      #  it "lists ruby versions that are compatible with this version of rails" do
+      #    list = @factory.rubies
+      #    list.should be_a(Array)
+      #    list.should_not be_empty
+      #  end
+      #
+      #  it 'the server should work with all the ruby versions' do
+      #    @factory.using.should == ''
+      #    @factory.rubies.each do |ruby_v|
+      #      @factory.logger.info("Checking ruby #{ruby_v} for compatibility with rails #{@factory.version}")
+      #      @factory.use(ruby_v) do
+      #        @factory.using.should == ruby_v
+      #        @factory.stop
+      #        @factory.system_in_app('bundle').should be_true
+      #        @factory.start.should be_true
+      #        actual_ruby_v = Net::HTTP.get(@factory.uri('/ruby_version'))
+      #        actual_version_should_match_rubies_version(actual_ruby_v, ruby_v, false)
+      #      end
+      #    end
+      #  end
+      #
+      #  it '9: stop server and rerun bundle' do
+      #    @factory.stop
+      #    @factory.system_in_app('bundle').should be_true
+      #   end
+      #end
+
+    end
+
+    describe '9: at the end' do
+      it 'the server log file should have contents' do
+        @factory.system_in_app 'du'
+        @factory.system_in_app 'ls -laR log'
+        File.size(File.join(@factory.root, "log/#{@factory.env}.log")).should > 0
+      end
+
+      it '9: destroy should remove the root directory' do
+        root = @factory.root
+        @factory.destroy
+        File.directory?(root).should be_false if root
+      end
+    end
+
+  end
+
+  # latest compatible rails version
+  context '::new (latest compatible version)' do
+    before(:all) do
+      @factory = RailsappFactory.new()
+    end
+    after(:all) do
+      @factory.destroy
+    end
+
+    it_behaves_like RailsappFactory
+  end
+
+  RailsappFactory.versions.each do |ver|
+    before(:all) do
+      @factory = RailsappFactory.new(ver)
+    end
+    after(:all) do
+      @factory.destroy
+    end
+
+    next if ver == RailsappFactory.versions.last # don't retest last version
+
+    context "::new(#{ver})" do
+
+      it_behaves_like RailsappFactory
+
+    end
+    #break unless ENV['TRAVIS'] == 'true'
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+module SpecHelper
+  def actual_version_should_match_rubies_version(actual_ruby_v, rubies_ruby_v, expect_prefix_and_patch = true)
+    prefix_string = rubies_ruby_v.sub(/^([a-zA-Z]*).*/, '\1')
+    if prefix_string == 'rbx'
+      prefix_string = 'rubinius'
+    elsif prefix_string == 'ree'
+      prefix_string = 'Ruby Enterprise Edition'
+    elsif prefix_string === ''
+      prefix_string = 'ruby'
+    end
+    ver_string = rubies_ruby_v.sub(/^\D*([\d\.]*).*/, '\1')
+    patch_string = if rubies_ruby_v =~ /.*?-p(\d+).*/
+                     "#{$1}"
+                   end
+    #puts "Matching #{prefix_string.inspect}, #{ver_string.inspect}, #{patch_string.inspect}"
+    actual_ruby_v.should include(ver_string)
+    if expect_prefix_and_patch
+      actual_ruby_v.should include(patch_string) if patch_string
+      actual_ruby_v.should include(prefix_string)
+    end
+  end
+
+end

data/spec/templates/add-file.rb

@@ -0,0 +1,6 @@
+file 'public/file.txt', <<-TEXT
+a short poem:
+  Fleas
+  Adam
+  Had 'em.
+TEXT

data/spec/templates/add-ruby_version-controller.rb

@@ -0,0 +1,9 @@
+generate :controller, 'ruby_version', 'index'
+
+file 'app/controllers/ruby_version_controller.rb', <<-TEXT
+class RubyVersionController < ApplicationController
+  def index
+    render :text => RUBY_VERSION
+  end
+end
+TEXT

data/spec/templates/add-yet-another-file.rb

@@ -0,0 +1,6 @@
+file 'public/yet-another-file.txt', <<-TEXT
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna
+aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint
+occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+TEXT