engine_cart 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8180b96510ff7c10e9a21625cca64768f90b52ee
-  data.tar.gz: 5872062cf96944e5ee713caf54dd49e8afe846e5
+  metadata.gz: 40c9b046588c71b4993de3134cdf47890d88fa84
+  data.tar.gz: 69cc69b06b1419055b1c8e28221f23785b8db7e7
 SHA512:
-  metadata.gz: 64e60694001844c9c0f171dc72364740beae0395a331f65609c73911f508eb5c265ddc785882318799fef9831e8d07b92e58460529ea58c567148b37b1b3fecd
-  data.tar.gz: 71e3fdbff0b743638aa212a4cc9b2ec313dd00b6c6ad1f711bf649f304128ecf0821f2b18d9f5dfbd56f7db629322208ef0c58985e8e0c7c2c9680b177df8e7e
+  metadata.gz: 6633db11d1f53e58552a84f399d1829db1a303d529ac2b1a0d0437c6f6358cf7080fbfd9af242a02f9c41c9c97b2a72b950ff31d8b473302af59bdc85e8561d2
+  data.tar.gz: abb7179ce65f9050b113ec94a7e4139a1ad7e1a0953fe179b24512243b358c01201cf0d40a12905a137ad8727183daef61060ea8a3824f85a8efb1d2cf1d954f

data/.travis.yml

@@ -1,16 +1,7 @@
 language: ruby
 sudo: false
 rvm:
-  - 2.4.1
-
-matrix:
-  include:
-    - rvm: jruby-9.1.13.0
-    - rvm: 2.3.4
-      env: "RAILS_VERSION=5.0.6"
-  allow_failures:
-    - rvm: jruby-9.1.13.0
-  fast_finish: true
+  - 2.4.4
 
 env:
- - "RAILS_VERSION=5.1.4"
+ - "RAILS_VERSION=5.2.0"

data/README.md

@@ -109,25 +109,7 @@ The EngineCart test application is meant to be disposable and easily rebuildable
 
 ### Automatic detection of when to rebuild test application
 
-In some cases, EngineCart can automatically detect and rebuild the test application when key files change. By default, the application will be rebuilt when your `Gemfile` or `Gemfile.lock` changes.
-
-It can also track changes to your engine's db migrations and generators with a fingerprint mechanism.  To use this, add the line below to your rake testing task:
-
-```ruby
-EngineCart.fingerprint_proc = EngineCart.rails_fingerprint_proc
-```
-
-For example, in your engine's Rakefile:
-
-```ruby
-require 'engine_cart/rake_task'
-
-task :ci do
-  EngineCart.fingerprint_proc = EngineCart.rails_fingerprint_proc
-  Rake::Task['engine_cart:generate'].invoke
-  # run the tests
-end
-```
+In some cases, EngineCart can automatically detect and rebuild the test application when key files change. By default, the application will be rebuilt when your `Gemfile`, `Gemfile.lock`, database migrations or generators change.
 
 ### Rake tasks for rebuilding test application
 

data/lib/engine_cart/configuration.rb

@@ -54,6 +54,10 @@ module EngineCart
       Array(options[:rails_options])
     end
 
+    def extra_fingerprinted_files
+      options[:extra_fingerprinted_files]
+    end
+
     def default_destination
       '.internal_test_app'
     end
@@ -74,7 +78,8 @@ module EngineCart
         destination: ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || default_destination,
         template: ENV['ENGINE_CART_TEMPLATE'],
         templates_path: ENV['ENGINE_CART_TEMPLATES_PATH'] || './spec/test_app_templates',
-        rails_options: parse_options(ENV['ENGINE_CART_RAILS_OPTIONS'])
+        rails_options: parse_options(ENV['ENGINE_CART_RAILS_OPTIONS']),
+        extra_fingerprinted_files: []
       }
     end
 

data/lib/engine_cart/tasks/engine_cart.rake

@@ -77,12 +77,8 @@ namespace :engine_cart do
   end
 
   desc "Create the test rails app"
-  task :generate, [:fingerprint] => [:setup] do |t, args|
-    original_fingerprint = args[:fingerprint]
-    args.with_defaults(:fingerprint => EngineCart.fingerprint) unless original_fingerprint
-
-    f = File.expand_path('.generated_engine_cart', EngineCart.destination)
-    unless File.exist?(f) && File.read(f) == args[:fingerprint]
+  task :generate => [:setup] do
+    if EngineCart.fingerprint_expired?
 
       # Create a new test rails app
       Rake::Task['engine_cart:create_test_rails_app'].invoke
@@ -106,7 +102,7 @@ namespace :engine_cart do
 
       Bundler.clean_system "bundle install --quiet"
 
-      File.open(File.expand_path('.generated_engine_cart', EngineCart.destination), 'w') { |f| f.write(original_fingerprint || EngineCart.fingerprint) }
+      EngineCart.write_fingerprint
 
       puts "Done generating test app"
     end

data/lib/engine_cart/version.rb

@@ -1,3 +1,3 @@
 module EngineCart
-  VERSION = '1.2.0'
+  VERSION = '2.0.0'
 end

data/lib/engine_cart.rb

@@ -2,6 +2,7 @@ require 'engine_cart/configuration'
 require "engine_cart/version"
 require 'engine_cart/gemfile_stanza'
 require 'bundler'
+require 'json'
 
 module EngineCart
   require "engine_cart/engine" if defined? Rails
@@ -18,26 +19,52 @@ module EngineCart
     end
   end
 
-  def self.fingerprint
-    @fingerprint || (@fingerprint_proc || method(:default_fingerprint)).call
+  def self.fingerprint_expired?
+    !fingerprint_current?
   end
 
-  def self.fingerprint= fingerprint
-    @fingerprint = fingerprint
+  def self.fingerprint_current?
+    return false unless File.exist? stored_fingerprint_file
+    content = File.read(stored_fingerprint_file)
+    data = JSON.parse(content, symbolize_names: true)
+    data == fingerprint
+  rescue
+    false
   end
 
-  def self.fingerprint_proc= fingerprint_proc
-    @fingerprint_proc = fingerprint_proc
+  def self.write_fingerprint
+    File.open(stored_fingerprint_file, 'w') do |f|
+      f.write(EngineCart.fingerprint.to_json)
+    end
   end
 
-  def self.rails_fingerprint_proc extra_files = []
-    lambda do
-      EngineCart.default_fingerprint + (Dir.glob("./db/migrate/*") + Dir.glob("./lib/generators/**/**") + Dir.glob("./spec/test_app_templates/**/**") + extra_files).map {|f| File.mtime(f) }.max.to_s
-    end
+  def self.stored_fingerprint_file
+    File.expand_path('.generated_engine_cart', EngineCart.destination)
+  end
+
+  def self.fingerprint
+    { env: env_fingerprint }.merge(files:
+      fingerprinted_files.map do |file|
+        { file: file, fingerprint: Digest::MD5.file(file).to_s }
+      end
+    )
+  end
+
+  def self.fingerprinted_files
+    Dir.glob("./*.gemspec").select { |f| File.file? f } +
+      [Bundler.default_gemfile.to_s, Bundler.default_lockfile.to_s] +
+      Dir.glob("./db/migrate/*").select { |f| File.file? f } +
+      Dir.glob("./lib/generators/**/**").select { |f| File.file? f } +
+      Dir.glob("./spec/test_app_templates/**/**").select { |f| File.file? f } +
+      configuration.extra_fingerprinted_files
+  end
+
+  def self.extra_fingerprinted_files=(extra_fingerprinted_files)
+    @extra_fingerprinted_files = extra_fingerprinted_files
   end
 
-  def self.default_fingerprint
-    EngineCart.env_fingerprint + (Dir.glob("./*.gemspec") + [Bundler.default_gemfile.to_s, Bundler.default_lockfile.to_s]).map {|f| File.mtime(f) }.max.to_s
+  def self.extra_fingerprinted_files
+    @extra_fingerprinted_files || []
   end
 
   def self.env_fingerprint

data/spec/integration/engine_cart_spec.rb

@@ -12,45 +12,48 @@ describe "EngineCart powered application" do
 
   it "should have a engine_cart:generate rake task available" do
     EngineCart.within_test_app do
-      `rake -T | grep "engine_cart:generate"`
+      `bundle exec rake -T | grep "engine_cart:generate"`
       expect($?).to eq 0
     end
   end
 
   it "should have a engine_cart:regenerate rake task available" do
     EngineCart.within_test_app do
-      `rake -T | grep "engine_cart:regenerate"`
+      `bundle exec rake -T | grep "engine_cart:regenerate"`
       expect($?).to eq 0
     end
   end
 
   it "should create a rails app when the engine_cart:generate task is invoked" do
     EngineCart.within_test_app do
-      `rake engine_cart:generate`
+      `bundle exec rake engine_cart:generate`
       expect(File).to exist(File.expand_path('.internal_test_app'))
     end
   end
 
   it "should not recreate an existing rails app when the engine_cart:generate task is reinvoked" do
     EngineCart.within_test_app do
-      `rake engine_cart:generate`
+      `bundle exec rake engine_cart:generate`
       expect(File).to exist(File.expand_path('.internal_test_app'))
       FileUtils.touch File.join('.internal_test_app', ".this_should_still_exist")
-      `rake engine_cart:generate`
+      `bundle exec rake engine_cart:generate`
       expect(File).to exist(File.expand_path(File.join('.internal_test_app', ".this_should_still_exist")))
     end
   end
-  
+
   it "should create a rails app when the fingerprint argument is changed" do
     EngineCart.within_test_app do
-      `rake engine_cart:generate[this-fingerprint]`
+      `bundle exec rake engine_cart:generate`
       expect(File).to exist(File.expand_path('.internal_test_app'))
       FileUtils.touch File.join('.internal_test_app', ".this_should_not_exist")
-      `rake engine_cart:generate[that-fingerprint]`
+      File.open('Gemfile', 'a') do |f|
+        f.puts "# some new content"
+      end
+      `bundle exec rake engine_cart:generate`
       expect(File).to_not exist(File.expand_path(File.join('.internal_test_app', ".this_should_not_exist")))
     end
   end
-  
+
   it "should be able to test the application controller from the internal app" do
     EngineCart.within_test_app do
       File.open('spec/some_spec.rb', 'w') do |f|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: engine_cart
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-08 00:00:00.000000000 Z
+date: 2018-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -111,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Helper for testing Rails Engines sanely