oop_rails_server 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29b80ec1bb5be7a985162051b138b86dcf1ba2df
-  data.tar.gz: 5250a68f7067cb3bd77c210673ba05b8623ceb14
+  metadata.gz: f07bd13a4e1384b5c4aaead8af1b980892fa6de8
+  data.tar.gz: 2d8a3a3a3af8fd99a6247bafcf9d4af731a1c583
 SHA512:
-  metadata.gz: 90699dbfd9174985ad3d9caf94362624d7c32ae2d7246d0488a64675a15a8bc3b13a6930b38d5f8bcc23706235720bb1ee990eaa3632f4e49c6f67b0237aa42b
-  data.tar.gz: 34f90b90785bd67871c7dced38dd782128255db383f39c592fffdfd1642c5a705f1fa4ed4cb69224be8630678b7fc4faca605cbb71e561bd7d410705edbc06ea
+  metadata.gz: 96d680a1199a5aa1eb124e1ea2bbc2efbec0c7ccd85a0e76f6e10d79ec4c1fb2a3f32f0e4a769eb96274700fe4a8040a0052c48d01b364bdb716e27737f0eb61
+  data.tar.gz: f9302281fcb1216edaf939e2dab8c6341f468f0272130ab1c9817ec5c5e8c2ad7e32055a5fccb3083be0a92fe9e6c956f2e1ba273d1522c2ef79b5072a995a0d

data/CHANGES.md

@@ -1,5 +1,10 @@
 # `oop_rails_server` Releases
 
+## 0.0.19, 20 September 2016
+
+* Significant internal refactor to how Gemfiles get modified that's much more reliable; changes
+  `:additional_gemfile_lines` into `:gemfile_modifier`, and from an array of `String`s to a `Proc`.
+
 ## 0.0.18, 20 September 2016
 
 * Replicate the workaround for `mime-types` into not just the Rails bootstrap Gemfile, but the Rails gemfile, too.

data/lib/oop_rails_server/gemfile.rb

@@ -0,0 +1,89 @@
+module OopRailsServer
+  # This is not intended to be anything even close to a real Gemfile parser -- it is just enough to create/parse
+  # the simple Gemfiles we create or that are generated by 'rails new'.
+  class Gemfile
+    def initialize(file_path)
+      @file_path = File.expand_path(file_path)
+    end
+
+    def add_version_constraints!(gem_name, *version_specs)
+      additional_version_constraints = version_specs.map { |vs| ", '#{vs}'" }.join
+
+      update_gemfile_line!(gem_name) do |gemdecl, specs|
+        "#{gemdecl}#{additional_version_constraints}#{specs}"
+      end
+    end
+
+    def set_specs!(gem_name, new_specs)
+      new_specs_line = new_specs.inspect
+      if new_specs_line =~ /^\s*\{\s*(.*?)\s*\}\s*$/
+        new_specs_line = $1
+      else
+        raise "Object doesn't seem to #inspect into a Hash string: #{new_specs.inspect}"
+      end
+
+      update_gemfile_line!(gem_name) do |gemdecl, specs|
+        "#{gemdecl}, #{new_specs_line}"
+      end
+    end
+
+    def ensure_gem!(gem_name)
+      update_gemfile_line!(gem_name) do |gemdecl, specs|
+        "#{gemdecl}#{specs}"
+      end
+    end
+
+    def write!
+      File.open(file_path, "w") do |f|
+        contents.each { |l| f.puts l }
+      end
+    end
+
+    private
+    attr_reader :file_path
+
+    GEM_LINE_REGEXP = /^(\s*gem\s+['"])([^"']+)(['"])(.*)$/
+
+    def update_gemfile_line!(gem_name)
+      found = nil
+
+      contents.each_with_index do |line, index|
+        if line =~ GEM_LINE_REGEXP && $2.strip.downcase == gem_name.strip.downcase
+          if found
+            raise "Multiple lines in '#{file_path}' seem to specify gem '#{gem_name}':\n     #{found[0]}: #{found[1]}\nand  #{index}: #{line}"
+          end
+
+          found = [ index, line ]
+        end
+      end
+
+      unless found
+        new_line = "gem '#{gem_name}'"
+        contents << new_line
+        found = [ (contents.length - 1), new_line ]
+      end
+
+      matchdata = GEM_LINE_REGEXP.match(found[1])
+      gemdecl = [ matchdata[1], matchdata[2], matchdata[3] ].join
+
+      modified_line = yield gemdecl, matchdata[4]
+      contents[found[0]] = modified_line
+    end
+
+    def contents
+      @contents ||= begin
+        c = if File.exist?(file_path)
+          File.read(file_path)
+        else
+          empty_gemfile_contents
+        end
+
+        c.split(/\n/)
+      end
+    end
+
+    def empty_gemfile_contents
+      "source 'https://rubygems.org'\n\n"
+    end
+  end
+end

data/lib/oop_rails_server/helpers.rb

@@ -77,8 +77,8 @@ it should return the fully-qualified path to the root of your project (gem, appl
       @rails_server_runtime_base_directory ||= File.join(rails_server_project_root, "tmp/spec/rails")
     end
 
-    def rails_server_additional_gemfile_lines
-      [ ]
+    def rails_server_gemfile_modifier
+      Proc.new { |gemfile| }
     end
 
     def rails_server_default_version
@@ -184,14 +184,19 @@ it should return the fully-qualified path to the root of your project (gem, appl
 
         template_paths = rails_server_template_paths(templates)
 
-        additional_gemfile_lines = Array(rails_server_additional_gemfile_lines || [ ])
-        additional_gemfile_lines += Array(options[:additional_gemfile_lines] || [ ])
+        rsgm = rails_server_gemfile_modifier
+        agm = options[:additional_gemfile_modifier] || (Proc.new { |gemfile| })
+
+        gemfile_modifier = Proc.new do |gemfile|
+          rsgm.call(gemfile)
+          agm.call(gemfile)
+        end
 
         server = ::OopRailsServer::RailsServer.new(
           :name => name, :template_paths => template_paths,
           :runtime_base_directory => rails_server_runtime_base_directory,
           :rails_version => (options[:rails_version] || rails_server_default_version),
-          :rails_env => options[:rails_env], :additional_gemfile_lines => additional_gemfile_lines)
+          :rails_env => options[:rails_env], :gemfile_modifier => gemfile_modifier)
 
         rails_servers[name] = server
 

data/lib/oop_rails_server/rails_server.rb

@@ -3,6 +3,7 @@ require 'find'
 require 'net/http'
 require 'uri'
 require 'file/tail'
+require 'oop_rails_server/gemfile'
 
 module OopRailsServer
   class RailsServer
@@ -11,7 +12,7 @@ module OopRailsServer
     def initialize(options)
       options.assert_valid_keys(
         :name, :template_paths, :runtime_base_directory,
-        :rails_version, :rails_env, :additional_gemfile_lines,
+        :rails_version, :rails_env, :gemfile_modifier,
         :log, :verbose
       )
 
@@ -30,7 +31,7 @@ module OopRailsServer
       @log = options[:log] || $stderr
       @verbose = options.fetch(:verbose, true)
 
-      @additional_gemfile_lines = Array(options[:additional_gemfile_lines] || [ ])
+      @gemfile_modifier = options[:gemfile_modifier] || (Proc.new { |gemfile| })
 
 
       @rails_root = File.expand_path(File.join(@runtime_base_directory, rails_version.to_s, name.to_s))
@@ -122,7 +123,7 @@ module OopRailsServer
     end
 
     private
-    attr_reader :template_paths, :runtime_base_directory, :rails_env, :additional_gemfile_lines, :port, :server_pid
+    attr_reader :template_paths, :runtime_base_directory, :rails_env, :gemfile_modifier, :port, :server_pid
 
     def base_template_directories
       [
@@ -192,22 +193,14 @@ module OopRailsServer
     end
 
     def splat_bootstrap_gemfile!
-      File.open("Gemfile", "w") do |f|
-        rails_version_spec = if rails_version == :default then "" else ", \"= #{rails_version}\"" end
-        f << <<-EOS
-source 'https://rubygems.org'
+      rails_version_specs = if rails_version == :default then [ ] else [ "= #{rails_version}" ] end
 
-gem 'rails'#{rails_version_spec}
-EOS
+      gemfile = ::OopRailsServer::Gemfile.new("Gemfile")
+      gemfile.add_version_constraints!("rails", *rails_version_specs)
 
-        f.puts "gem 'i18n', '< 0.7.0'" if RUBY_VERSION =~ /^1\.8\./
-        f.puts "gem 'rack-cache', '< 1.3.0'" if RUBY_VERSION =~ /^1\./
-        f.puts "gem 'rake', '< 11.0.0'" if RUBY_VERSION =~ /^1\.8\./
-
-        # mime-types 3.x depends on mime-types-data, which is incompatible with Ruby < 1.x
-        f.puts "gem 'mime-types', '< 3.0.0'" if RUBY_VERSION =~ /^1\./
-      end
+      backcompat_bootstrap_gems!(gemfile)
 
+      gemfile.write!
       run_bundle_install!(:bootstrap)
     end
 
@@ -220,48 +213,16 @@ EOS
     end
 
     def update_gemfile!
-      gemfile = File.join(rails_root, 'Gemfile')
-      gemfile_contents = File.read(gemfile)
-
-      # Since Rails 3.0.20 was released, a new version of the I18n gem, 0.5.2, was released that moves a constant
-      # into a different namespace. (See https://github.com/mislav/will_paginate/issues/347 for more details.)
-      # So, if we're running Rails 3.0.x, we lock the 'i18n' gem to an earlier version.
-      if rails_version && rails_version =~ /^3\.0\./
-        gemfile_contents << "\ngem 'i18n', '= 0.5.0'\n"
-      elsif RUBY_VERSION =~ /^1\.8\./
-        # Since Rails 3.x was released, a new version of the I18n gem, 0.7.0, was released that is incompatible
-        # with Ruby 1.8.7. So, if we're running with Ruby 1.8.7, we lock the 'i18n' gem to an earlier version.
-        gemfile_contents << "\ngem 'i18n', '< 0.7.0'\n"
-      end
+      gemfile = ::OopRailsServer::Gemfile.new(File.join(rails_root, 'Gemfile'))
 
-      # Since Rails 3.1.12 was released, a new version of the rack-cache gem, 1.3.0, was released that requires
-      # Ruby 2.0 or above. So, if we're running Rails 3.1.x or 3.2.x on Ruby 1.8.x, we lock the 'rack-cache' gem
-      # to an earlier version.
-      if rails_version && rails_version =~ /^3\.[12]\./ && RUBY_VERSION =~ /^1\./
-        gemfile_contents << "\ngem 'rack-cache', '< 1.3.0'\n"
-      end
+      backcompat_bootstrap_gems!(gemfile)
 
-      if RUBY_VERSION =~ /^1\.8\./
-        # Apparently execjs released a version 2.2.0 that will happily install on Ruby 1.8.7, but which contains some
-        # new-style hash syntax. As a result, we pin the version backwards in this one specific case.
-        gemfile_contents << "\ngem 'execjs', '~> 2.0.0'\n"
-
-        # Rake 11 is incompatible with Ruby 1.8
-        gemfile_contents << "\ngem 'rake', '< 11.0.0'\n"
+      backcompat_execjs!(gemfile)
+      backcompat_uglifier!(gemfile)
 
-        # Uglifier 3 is incompatible with Ruby 1.8
-        gemfile_contents.gsub!(/^(.*['"]uglifier['"].*)$/, "\\1, '< 3.0.0'")
-      end
-
-      if RUBY_VERSION =~ /^1\./
-        # mime-types 3.x depends on mime-types-data, which is incompatible with Ruby < 1.x
-        gemfile_contents << "\ngem 'mime-types', '< 3.0.0'\n"
-      end
+      gemfile_modifier.call(gemfile)
 
-      gemfile_contents << additional_gemfile_lines.join("\n")
-      gemfile_contents << "\n"
-
-      File.open(gemfile, 'w') { |f| f << gemfile_contents }
+      gemfile.write!
     end
 
     def with_env(new_env)
@@ -562,5 +523,82 @@ and output:
 
       output
     end
+
+
+    def is_ruby_18
+      !! (RUBY_VERSION =~ /^1\.8\./)
+    end
+
+    def is_ruby_1
+      !! (RUBY_VERSION =~ /^1\./)
+    end
+
+    def is_rails_30
+      rails_version && rails_version =~ /^3\.0\./
+    end
+
+    def is_rails_31
+      rails_version && rails_version =~ /^3\.1\./
+    end
+
+    def is_rails_32
+      rails_version && rails_version =~ /^3\.2\./
+    end
+
+    def backcompat_i18n!(gemfile)
+      if is_rails_30
+        # Since Rails 3.0.20 was released, a new version of the I18n gem, 0.5.2, was released that moves a constant
+        # into a different namespace. (See https://github.com/mislav/will_paginate/issues/347 for more details.)
+        # So, if we're running Rails 3.0.x, we lock the 'i18n' gem to an earlier version.
+        gemfile.add_version_constraints!('i18n', '= 0.5.0')
+      elsif is_ruby_18
+        # Since Rails 3.x was released, a new version of the I18n gem, 0.7.0, was released that is incompatible
+        # with Ruby 1.8.7. So, if we're running with Ruby 1.8.7, we lock the 'i18n' gem to an earlier version.
+        gemfile.add_version_constraints!('i18n', '< 0.7.0')
+      end
+    end
+
+    def backcompat_rake!(gemfile)
+      if is_ruby_18
+        # Rake 11 is incompatible with Ruby 1.8
+        gemfile.add_version_constraints!('rake', '< 11.0.0')
+      end
+    end
+
+    def backcompat_rack_cache!(gemfile)
+      if is_ruby_1 && (is_rails_31 || is_rails_32)
+        # Since Rails 3.1.12 was released, a new version of the rack-cache gem, 1.3.0, was released that requires
+        # Ruby 2.0 or above. So, if we're running Rails 3.1.x or 3.2.x on Ruby 1.x, we lock the 'rack-cache' gem
+        # to an earlier version.
+        gemfile.add_version_constraints!('rack-cache', '< 1.3.0')
+      end
+    end
+
+    def backcompat_mime_types!(gemfile)
+      if is_ruby_1
+        # mime-types 3.x depends on mime-types-data, which is not compatible with ruby < 2.x
+        gemfile.add_version_constraints!('mime-types', '< 3.0.0')
+      end
+    end
+
+    def backcompat_execjs!(gemfile)
+      if is_ruby_18
+        # Apparently execjs released a version 2.2.0 that will happily install on Ruby 1.8.7, but which contains some
+        # new-style hash syntax. As a result, we pin the version backwards in this one specific case.
+        gemfile.add_version_constraints!('execjs', '~> 2.0.0')
+      end
+    end
+
+    def backcompat_uglifier!(gemfile)
+      # Uglifier 3 is incompatible with Ruby 1.8
+      gemfile.add_version_constraints!('uglifier', '< 3.0.0')
+    end
+
+    def backcompat_bootstrap_gems!(gemfile)
+      backcompat_i18n!(gemfile)
+      backcompat_rake!(gemfile)
+      backcompat_rack_cache!(gemfile)
+      backcompat_mime_types!(gemfile)
+    end
   end
 end

data/lib/oop_rails_server/version.rb

@@ -1,3 +1,3 @@
 module OopRailsServer
-  VERSION = "0.0.18"
+  VERSION = "0.0.19"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oop_rails_server
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - Andrew Geweke
@@ -80,6 +80,7 @@ files:
 - README.md
 - Rakefile
 - lib/oop_rails_server.rb
+- lib/oop_rails_server/gemfile.rb
 - lib/oop_rails_server/helpers.rb
 - lib/oop_rails_server/rails_server.rb
 - lib/oop_rails_server/version.rb