lurker 0.6.8 → 1.0.0

data/spec/spec_helper.rb

@@ -15,7 +15,6 @@ end
 Dir[File.expand_path '../support/**/*.rb', __FILE__].each { |file| require file }
 
 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
   config.order = 'random'

data/tasks/build.rake

@@ -8,13 +8,13 @@ namespace :assets do
     require 'lurker/cli'
 
     require 'sprockets'
-    require 'sass'
+    require 'sass-rails'
 
     ROOT        = Pathname(File.dirname(__FILE__))
     LOGGER      = Logger.new(STDOUT)
     BUNDLES     = %w( application.css application.js )
-    BUILD_DIR   = Pathname.new Lurker::Cli.precompiled_static_root
-    SOURCE_DIR  = Pathname.new Lurker::Cli.source_root
+    BUILD_DIR   = Lurker::Cli.assets_root
+    SOURCE_DIR  = Lurker::Cli.templates_root
 
     FileUtils.rm_rf(BUILD_DIR)
     FileUtils.mkdir_p(BUILD_DIR)
@@ -38,8 +38,10 @@ namespace :assets do
     sprockets.append_path(SOURCE_DIR.join('stylesheets').to_s)
 
     %w[jquery-rails bootstrap-sass remotipart lurker].each do |gem|
-      gem_path = Pathname.new(Bundler.rubygems.find_name(gem).first.full_gem_path)
-      %w[javascripts stylesheets].each do |prefix|
+      bundler_gem = Bundler.rubygems.find_name(gem).first
+      raise "Gem #{gem.inspect} is required in #{ENV.fetch('BUNDLE_GEMFILE', 'Gemfile')}" unless bundler_gem
+      gem_path = Pathname.new(bundler_gem.full_gem_path)
+      %w[javascripts stylesheets fonts].each do |prefix|
         %w[assets vendor/assets lib/lurker/templates].each do |interfix|
           path = gem_path.join(interfix, prefix).to_s
           sprockets.append_path(path) if File.exists? path
@@ -47,12 +49,14 @@ namespace :assets do
       end
     end
 
-    sprockets.js_compressor  = :uglify
-    sprockets.css_compressor  = :scss
+    unless ENV['CI']
+      sprockets.js_compressor  = :uglify
+      sprockets.css_compressor  = :scss
+    end
 
     BUNDLES.each do |bundle|
       assets = sprockets.find_asset(bundle)
-      realname = (assets.pathname.basename.to_s.split(".").take_while { |s| !s.match /^(js|css|scss)$/ } + [$~.to_s]).join(".").gsub(/\.scss$/, '.css')
+      realname = (Pathname.new(assets.filename).basename.to_s.split(".").take_while { |s| !s.match /^(js|css|scss)$/ } + [$~.to_s]).join(".").gsub(/\.scss$/, '.css')
       assets.write_to(BUILD_DIR.join(realname))
     end
   end

data/tasks/generate.rake

@@ -1,7 +1,15 @@
-if rails_version = ENV['BUNDLE_GEMFILE'].to_s.match(/rails_\d\d/)
-  EXAMPLE_APP = "tmp/lurker_app_#{rails_version}"
+def rails_version
+  if (version = ENV['BUNDLE_GEMFILE'].to_s.match(/rails_([\d\.]+).gemfile/)&.to_a&.last)
+    Gem::Version.new(version)
+  end
+end
+
+if rails_version
+  EXAMPLE_APP = "tmp/lurker_app_rails_#{rails_version}"
+  TEMPLATE_TASK = rails_version >= Gem::Version.new('5.0') ? 'app:template' : 'rails:template'
+  TASK_RUNNER = rails_version >= Gem::Version.new('5.0') ? 'bin/rails' : 'bin/rake'
 else
-  raise "Use `appraisal rails-XY rake ...` or export BUNDLE_GEMFILE=gemfiles/... explicitly"
+  raise "Export BUNDLE_GEMFILE=gemfiles/rails_... explicitly"
 end
 
 EXAMPLE_PATH = File.expand_path("../../#{EXAMPLE_APP}", __FILE__)
@@ -30,30 +38,33 @@ namespace :generate do
   task :app do |t|
     if needs_generation?
       sh "bundle exec rails new #{EXAMPLE_APP} -d postgresql -m #{File.expand_path '../../templates/lurker_app.rb', __FILE__} --skip-javascript --skip-git --skip-test-unit --skip-keeps --skip-bundle --quiet"
-      in_lurker_app "bundle config --local local.lurker $PWD/../.." unless ENV['TRAVIS']
-      in_lurker_app "bundle install --without development --quiet"
-      %w[rake rspec-core spring].each do |gem|
-        in_lurker_app "bundle binstubs #{gem}"
+      in_lurker_app "bundle config --local local.lurker $PWD/../.." unless ENV['CI']
+      in_lurker_app "bundle config --local set without 'development'"
+      in_lurker_app "bundle install"
+      %w[rake rspec-core spring bundler].each do |gem|
+        in_lurker_app "bundle binstubs #{gem} --force"
       end
     end
   end
 
   desc "generate a bunch of stuff with generators"
   task :stuff do
-    in_lurker_app "LOCATION='../../templates/generate_stuff.rb' bin/rake rails:template --quiet --silent"
+    in_lurker_app "LOCATION='../../templates/generate_stuff.rb' #{TASK_RUNNER} #{TEMPLATE_TASK}"
 
-    unless ENV['TRAVIS']
-      in_lurker_app 'bin/rake db:setup'
-      in_lurker_app 'bin/rake db:import'
+    if ENV['CI']
+      in_lurker_app "#{TASK_RUNNER} RAILS_ENV=test db:setup "
+    else
+      in_lurker_app "#{TASK_RUNNER} db:setup"
+      in_lurker_app "#{TASK_RUNNER} db:import"
     end
-    in_lurker_app 'bin/rake RAILS_ENV=test db:setup'
   end
 end
 
 def in_lurker_app(command)
   FileUtils.mkdir_p(EXAMPLE_PATH)
   Dir.chdir(EXAMPLE_PATH) do
-    Bundler.with_clean_env do
+    bundler_method = Bundler.respond_to?(:with_unbundled_env) ? :with_unbundled_env : :with_clean_env
+    Bundler.send(bundler_method) do
       sh command
     end
   end
@@ -63,23 +74,39 @@ def needs_generation?
   !File.exists?("#{EXAMPLE_PATH}/Gemfile")
 end
 
+def place_github_badge(fname)
+  full_fname = "#{EXAMPLE_PATH}/#{fname}"
+  content = File.read(full_fname).gsub("</header>", <<-EOF
+    </header>
+    <a href='https://github.com/razum2um/lurker'>
+      <img style='position: absolute; top: 0; right: 0; border: 0; z-index: 1000'
+           src="https://camo.githubusercontent.com/365986a132ccd6a44c23a9169022c0b5c890c387/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f7265645f6161303030302e706e67"
+           data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
+           alt='Fork me on GitHub'>
+    </a>
+    EOF
+    )
+  File.open(full_fname, 'w') { |f| f.write content }
+end
+
 desc 'destroys & recreates new test app'
-task :regenerate => ["clobber:coverage", "clobber:app", "generate:app", "generate:stuff"]
+task :regenerate => ["clobber:coverage", "clobber:app", "assets:precompile", "generate:app", "generate:stuff"]
 
 desc 'run cucumber in a fresh env'
 task :features => [:regenerate, :cucumber]
 
 desc 'convert docs for example app, prepages gh-pages, having schemas in /lurker'
 task :convert_example_docs do
+  in_lurker_app "bin/lurker init_docs"
+
   if File.exists?(readme = File.expand_path('../../README.md', __FILE__))
     in_lurker_app "bin/lurker convert -c #{readme}"
   else
     in_lurker_app "bin/lurker convert"
   end
 
-  in_lurker_app %Q{sed -i "" "s|</header>|</header><a href='https://github.com/razum2um/lurker'><img style='position: absolute; top: 0; right: 0; border: 0; z-index: 1000' src='https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png' alt='Fork me on GitHub'></a>|" public/lurker/index.html}
-  in_lurker_app "bin/lurker convert -f pdf"
+  place_github_badge 'public/lurker/index.html'
+  # in_lurker_app "bin/lurker convert -f pdf"
 end
 
 task :build_example_docs => [:features, :convert_example_docs]
-

data/templates/Dockerfile

@@ -0,0 +1,26 @@
+# cd tmp/lurker_app_*, run with
+# docker run -e DATABASE_URL=postgres://user@host.docker.internal/lurker_app_rails_6 -p 3000:3000 lurker"
+FROM ruby:2.7-alpine as build
+
+WORKDIR /app
+
+RUN apk add git postgresql-dev libpq
+
+COPY Gemfile* ./
+
+RUN apk add --no-cache --update alpine-sdk make && \
+    bundler config set without 'development test' && \
+    bundler config set path 'vendor/bundle' && \
+    bundler install
+
+COPY . ./
+
+EXPOSE 3000
+
+ENV PATH "$PATH:/app/vendor/bundle/ruby/2.7.0/bin"
+ENV GEM_HOME "/app/vendor/bundle/ruby/2.7.0"
+ENV RAILS_ENV "production"
+ENV RAILS_SERVE_STATIC_FILES "1"
+ENV RAILS_LOG_TO_STDOUT "1"
+
+CMD ["bin/rails", "s", "-b", "0.0.0.0"]

data/templates/generate_stuff.rb

@@ -1,13 +1,12 @@
 # This is secondary testing/demo rails app template (passed to `rake rails:template`)
-
-if rails_version = ENV['BUNDLE_GEMFILE'].to_s.match(/rails_\d\d/)
+if rails_version = ENV['BUNDLE_GEMFILE'].to_s.match(/rails_\d+/)
   base_db_name = "lurker_app_#{rails_version}"
 else
   base_db_name = 'lurker_app'
 end
 
 file 'config/database.yml', force: true do
-  <<-CODE
+  <<~CODE
 default: &default
   adapter: postgresql
   encoding: unicode
@@ -25,7 +24,7 @@ end
 
 copy_file "#{File.expand_path '../../bin/lurker', __FILE__}", "bin/lurker"
 inject_into_file "bin/lurker", before: /require .lurker.$/ do
-  <<-CODE
+  <<~CODE
     if (simplecov_root = ENV['SIMPLECOV_ROOT']) && (simplecov_cmdname = ENV['SIMPLECOV_CMDNAME'])
       require 'simplecov'
       SimpleCov.start
@@ -50,7 +49,7 @@ remove_file 'app/models/user.rb'
 
 generate 'rspec:install'
 
-route <<-ROUTE
+route <<~ROUTE
   namespace :api do
     namespace :v1 do
       resources :users do
@@ -86,7 +85,7 @@ generate 'model User name:string surname:string --no-timestamps --no-test-framew
 generate 'model Repo user:references name:string --no-timestamps --no-test-framework --no-migration'
 
 file 'config/initializers/serializer.rb', force: true do
-  <<-CODE
+  <<~CODE
     module ExactOrderAsJson
       # we need EXACT order for json attributes generation (e.g. rails32 sorts it)
       # see: https://github.com/rails/rails/pull/5678/files
@@ -109,10 +108,8 @@ file 'config/initializers/serializer.rb', force: true do
   CODE
 end
 
-copy_file "#{File.expand_path '../../templates/rails32_http_patch_support.rb', __FILE__}", "config/initializers/rails32_http_patch_support.rb"
-
 inject_into_class 'app/models/user.rb', 'User' do
-  <<-CODE
+  <<~CODE
     include ExactOrderAsJson
     has_many :repos
     validates :name, presence: true
@@ -124,17 +121,17 @@ inject_into_class 'app/models/user.rb', 'User' do
 end
 
 inject_into_class 'app/models/repo.rb', 'Repo' do
-  <<-CODE
+  <<~CODE
     include ExactOrderAsJson
     validates :name, presence: true
   CODE
 end
 
 file 'app/controllers/application_controller.rb', 'ApplicationController', force: true do
-  <<-CODE
+  <<~CODE
     class ApplicationController < ActionController::Base
       protect_from_forgery with: :null_session
-      before_filter :set_format
+      before_action :set_format
 
       private
 
@@ -154,7 +151,7 @@ file 'app/controllers/application_controller.rb', 'ApplicationController', force
 end
 
 file 'app/controllers/api/v1/users_controller.rb', 'Api::V1::UsersController', force: true do
-  <<-CODE
+  <<~CODE
     class Api::V1::UsersController < ApplicationController
       def index
         @users = scoped(User)
@@ -174,7 +171,7 @@ file 'app/controllers/api/v1/users_controller.rb', 'Api::V1::UsersController', f
       end
 
       def update
-        if user.update_attributes(user_params)
+        if user.update(user_params)
           render json: user
         else
           render json: { errors: user.errors }, status: :bad_request
@@ -209,7 +206,7 @@ file 'app/controllers/api/v1/users_controller.rb', 'Api::V1::UsersController', f
 end
 
 file 'app/controllers/api/v1/repos_controller.rb', 'Api::V1::ReposController', force: true do
-  <<-CODE
+  <<~CODE
     class Api::V1::ReposController < ApplicationController
 
       def index
@@ -235,7 +232,7 @@ file 'app/controllers/api/v1/repos_controller.rb', 'Api::V1::ReposController', f
 
       def update
         @repo = repo
-        if @repo.update_attributes(repo_params)
+        if @repo.update(repo_params)
           render json: @repo
         else
           render json: { errors: @repo.errors }, status: :bad_request
@@ -272,13 +269,13 @@ end
 
 [2, 3].each do |version|
   file "app/controllers/api/v#{version}/users_controller.rb", "Api::V#{version}::UsersController", force: true do
-    <<-CODE
+    <<~CODE
       class Api::V#{version}::UsersController < Api::V1::UsersController; end
     CODE
   end
 
   file "app/controllers/api/v#{version}/repos_controller.rb", "Api::V#{version}::ReposController", force: true do
-    <<-CODE
+    <<~CODE
       class Api::V#{version}::ReposController < Api::V1::ReposController; end
     CODE
   end
@@ -286,19 +283,19 @@ end
 
 # FIXME: uninitialized constant User (NameError) in last creation line
 append_to_file 'config/environment.rb' do
-  <<-CODE
+  <<~CODE
     $:.unshift File.expand_path('../../app/models', __FILE__)
   CODE
 end
 
 inject_into_class 'config/application.rb', 'Application' do
-  <<-CODE
+  <<~CODE
     if ENV['DATABASE_URL'].present? # heroku
       config.middleware.use Lurker::Sandbox
     end
 
     require 'rack/cors' # FIXME
-    config.middleware.insert 0, "Rack::Cors" do
+    config.middleware.insert 0, Rack::Cors do
       allow do
         origins %w[localhost:3000 127.0.0.1:3000 razum2um.github.io lurker-app.herokuapp.com lurker.razum2um.me]
         resource '*',
@@ -314,7 +311,7 @@ inject_into_class 'config/application.rb', 'Application' do
 end
 
 file 'test/test_helper.rb', force: true do
-  <<-CODE
+  <<~CODE
     ENV['RAILS_ENV'] ||= 'test'
     require File.expand_path('../../config/environment', __FILE__)
     require 'rails/test_help'
@@ -338,9 +335,16 @@ file 'test/test_helper.rb', force: true do
 end
 
 file 'spec/support/fixme.rb', force: true do
-  <<-CODE
+  <<~CODE
     require 'simplecov'
 
+    module ActionDispatchTestResponseCompat
+      def success?
+        status == 200
+      end
+    end
+    ActionDispatch::TestResponse.include(ActionDispatchTestResponseCompat)
+
     if simplecov_root = ENV['SIMPLECOV_ROOT']
       SimpleCov.root simplecov_root
     end
@@ -362,7 +366,6 @@ file 'spec/support/fixme.rb', force: true do
 
     RSpec.configure do |c|
       c.infer_spec_type_from_file_location! if c.respond_to?(:infer_spec_type_from_file_location!)
-      c.treat_symbols_as_metadata_keys_with_true_values = true
       c.backtrace_exclusion_patterns += [
         /\\/lib\\/lurker/
       ]
@@ -385,7 +388,7 @@ file 'spec/support/fixme.rb', force: true do
 end
 
 file 'lib/tasks/db.rake', force: true do
-  <<-CODE
+  <<~CODE
     namespace :db do
       desc 'fills in data'
       task :import => :environment do
@@ -398,7 +401,7 @@ file 'lib/tasks/db.rake', force: true do
 end
 
 file 'db/schema.rb', force: true do
-  <<-CODE
+  <<~CODE
     ActiveRecord::Schema.define do
       create_table "repos", :force => true do |t|
         t.integer "user_id"
@@ -415,3 +418,33 @@ file 'db/schema.rb', force: true do
   CODE
 end
 
+append_to_file 'spec/rails_helper.rb' do
+  <<~CODE
+    Dir[File.expand_path '../support/**/*.rb', __FILE__].each { |file| require file }
+
+    if Gem::Version.new(Rails.version) < Gem::Version.new('5.0.0')
+      require 'rails/forward_compatible_controller_tests'
+      RSpec.configure do |config|
+        config.include Rails::ForwardCompatibleControllerTests, type: :controller
+        config.include Rails::ForwardCompatibleControllerTests, type: :request
+      end
+    end
+  CODE
+end
+
+append_to_file '.rspec' do
+  <<~CODE
+    --require rails_helper
+  CODE
+end
+
+copy_file "#{File.expand_path '../../templates/Dockerfile', __FILE__}", "Dockerfile"
+
+# rails-4 requires this
+file 'app/assets/config/manifest.js', force: true do
+  <<~CODE
+  // empty
+  CODE
+end
+
+copy_file "#{File.expand_path '../../templates/rails4_ruby26_thread_error_fix.rb', __FILE__}", "spec/support/rails4_ruby26_thread_error_fix.rb"

data/templates/lurker_app.rb

@@ -1,38 +1,37 @@
 # This is initial testing/demo rails app template (passed to `rails new`)
 
 gem 'rack-cors', require: 'rack/cors'
-gem 'rspec-rails', '~> 2.14.0'
-gem 'spring-commands-rspec'
-gem 'database_cleaner'
+gem 'rspec-rails', group: [:development, :test]
+gem 'spring-commands-rspec', group: [:development, :test]
+gem 'database_cleaner', group: [:development, :test]
 gem 'simplecov', '~> 0.7.1', require: false
-gem 'kramdown',  '~> 1.3'
-gem 'pdfkit', '~> 0.5'
-gem 'wkhtmltopdf-binary', '~> 0.9'
-gem 'execjs'
-gem 'coderay'
-
-unless ENV['TRAVIS']
-  if RUBY_VERSION > '2.0.0'
-    gem 'pry-byebug', group: [:development, :test]
-  else
-    gem 'pry-debugger', group: [:development, :test]
-  end
-  gem 'pry-stack_explorer', group: [:development, :test]
+gem 'kramdown',  '~> 1.3', group: [:development, :test]
+gem 'pdfkit', '~> 0.5', group: [:development, :test]
+gem 'wkhtmltopdf-binary', '~> 0.9', group: [:development, :test]
+gem 'execjs', group: [:development, :test]
+gem 'coderay', group: [:development, :test]
+
+# only for rails-4
+version = ENV['BUNDLE_GEMFILE'].to_s.match(/rails_([\d\.]+).gemfile/)&.to_a&.last
+if version && (Gem::Version.new(version) < Gem::Version.new('5'))
+  gem 'rails-forward_compatible_controller_tests', group: [:development, :test], require: false
 end
 
-gem 'unicorn', group: :production
-gem 'therubyracer', group: :production
+unless ENV['CI']
+  gem 'pry-byebug', group: [:development, :test]
+end
 
 append_to_file 'Gemfile' do
-  gem = if ENV['TRAVIS']
-    "gem 'lurker', github: 'razum2um/lurker', branch: 'master'"
+  gem = if ENV['CI']
+    branch = ENV['TRAVIS_BRANCH'] || %x[git branch --show-current]
+    "gem 'lurker', github: 'razum2um/lurker', branch: '#{branch.strip}'"
   else
     origin = `cd ../.. && git config --get remote.origin.url`.scan(/github\.com.(.*).git/).flatten.first.strip rescue 'razum2um/lurker'
     branch = `cd ../.. && git rev-parse --abbrev-ref HEAD`.strip rescue 'master'
     "gem 'lurker', github: '#{origin}', branch: '#{branch}'"
   end
 
-  <<-CODE
+  <<~CODE
 
     # new line above is important, branch is also important
     # please, dont commit here: "gem 'lurker', path: '../../'"
@@ -41,34 +40,14 @@ append_to_file 'Gemfile' do
   CODE
 end
 
-file 'config/unicorn.rb' do
-  <<-CODE
-    worker_processes Integer(ENV["WEB_CONCURRENCY"] || 3)
-    timeout 15
-    preload_app true
-
-    before_fork do |server, worker|
-      Signal.trap 'TERM' do
-        puts 'Unicorn master intercepting TERM and sending myself QUIT instead'
-        Process.kill 'QUIT', Process.pid
-      end
-
-      defined?(ActiveRecord::Base) and ActiveRecord::Base.connection.disconnect!
-    end
-
-    after_fork do |server, worker|
-      Signal.trap 'TERM' do
-        puts 'Unicorn worker intercepting TERM and doing nothing. Wait for master to send QUIT'
-      end
-
-      defined?(ActiveRecord::Base) and ActiveRecord::Base.establish_connection
-    end
-  CODE
-end
-
 file 'Procfile' do
-  <<-CODE
-    web: bundle exec unicorn -p $PORT -c ./config/unicorn.rb
+  <<~CODE
+    web: bundle exec puma -p $PORT
   CODE
 end
 
+# docker needs with for mri too
+gsub_file('Gemfile', /gem.*tzinfo-data.*/, 'gem "tzinfo-data"')
+
+# pg 0.21 with rails-4 has too much warnings
+gsub_file('Gemfile', "gem 'pg', '~> 0.15'", "gem 'pg', '<= 0.20'")