wagons 0.7.0 → 0.8.0

data/README.rdoc

@@ -1,147 +0,0 @@
-= Here Be Wagons
-
-{<img src="https://github.com/codez/wagons/actions/workflows/build.yml/badge.svg" />}[https://github.com/codez/wagons/actions/workflows/build.yml]
-{<img src="https://api.codeclimate.com/v1/badges/32a0d860544681cf718c/maintainability" />}[https://codeclimate.com/github/codez/wagons/maintainability]
-
-Wagons are extensions to your application train running on Rails. You can see them as plugins that
-extend the behavior of your specific Rails application. This framework makes it easy to create and
-manage them.
-
-First of all, wagons are basically {Rails Engines}[http://api.rubyonrails.org/classes/Rails/Engine.html],
-so make sure you are familiar with them. Wagons provide a handful of additions so your wagon
-engines actually know your application.
-
-Wagons differ from engines in a few points:
-
-* Wagons extend your application, engines extend Rails.
-* Wagon migrations are kept separately from your application's migrations to enable easy addition and removal of wagons.
-* When developing and testing, wagons use the main application instead of a dummy application.
-
-== Setup
-
-As always, add this declaration to your application's Gemfile:
-
-  gem 'wagons'
-
-Now you are ready for your first wagon. Generate it with
-
-  rails generate wagon [name]
-
-This creates the structure of your wagon in <tt>vendor/wagons/[name]</tt>. In there, you find the file <tt>lib/[name]/wagon.rb</tt>,
-which defines the <tt>Rails::Engine</tt> and includes the +Wagon+ module. Here, you may also extend your application
-classes in a +config.to_prepare+ block.
-
-In order to load wagons with the application, an entry in the +Gemfile+ would be sufficient.
-To keep things flexible, wagons come with an additional file +Wagonfile+. Generate one for development purposes with:
-
-  rake wagon:file
-
-This will include all wagons found in +vendor/wagons+ in development mode.
-Do not check +Wagonfile+ into source control. In your deployments, you might want to have different entries in there.
-
-Once your wagon is ready to ship, a gem can be built with <tt>rake build</tt>. The name of a wagon gem must always start
-with the application name, followed with an underscore and the actual name of the wagon. In production, you may
-simply install the wagon gem and explicitly add a declaration to your +Wagonfile+.
-
-If your wagon contains migrations and probably seed data, update your database with
-
-  rake wagon:setup WAGON=[name]
-
-Leave off the +WAGON+ parameter to setup all wagons in your +Wagonfile+. This should not interfere with wagons that are
-already set up. Migrations are only run if they are not loaded yet, as usual.
-
-
-== Extending your application with a wagon
-
-Ruby and Rails provide all the magic required to extend your application from within a wagon.
-
-To add new models, controllers or views, simply create them in the +app+ directory of your wagon, as you would in a regular engine.
-
-To extend existing models and controllers, you may create modules with the required functionality.
-Include them into your application classes in a +config.to_prepare+ block in <tt>lib/[wagon_name]/wagon.rb</tt>.
-
-To extend views, wagons provides a simple view helper that looks for partials in all view paths. Any template that
-might be extended by a wagon can include a call like this:
-
-  <%= render_extensions :details %>
-
-Any partials living in an equally named subfolder as the calling template and starting with the given key are rendered at this place.
-
-
-== Wagon dependencies
-
-Wagons may depend on each other and/or have certain requirements on their load order. To make sure something
-is loaded before the current wagon, add a <tt>require '[app_name]_[other_wagon]'</tt> on top of the
-<tt>lib/[app_name]_[current_wagon].rb</tt> file. For development dependencies, there is an extra +require_optional+
-method that will not raise a +LoadError+ if the dependency is not found.
-
-To control that the main application actually supports a certain wagon, an application version may be defined
-so wagons can define a requirement. The application version can be set in an initializer. Create it with:
-
-  rake wagon:app_version
-
-Besides setting the version, this initializer will check all loaded wagons for their application requirement
-and raise errors if one is not met. In <tt>lib/[wagon_name]/wagon.rb</tt> the requirement may be defined, e.g.:
-
-  app_requirement '>= 1.0'
-
-The syntax follows the Ruby gem version and requirements.
-
-
-== Seed Data
-
-Wagons integrates {Seed Fu}[https://github.com/mbleigh/seed-fu] for seed data. All seed data from the application
-is also available in wagon tests, as long as no fixture files overwrite the corresponding tables.
-
-Wagons may come with their own seed data as well. Simply put it into <tt>db/fixtures[/environment]</tt>. To allow for
-an automatic removal of wagons, {Seed Fu-ndo}[https://github.com/codez/seed-fu-ndo] is able to record
-seed file instructions and destroy all entries that exist in the database. Just make sure that you only use
-the +seed+ and +seed_once+ methods in these files, or the unseed may not work correctly.
-
-
-== Beware
-
-There are a few other things that work differently with wagons:
-
-=== Schema & Migrations
-
-Wagons are extensions to your application that may vary between various installations. Wagon tables are added
-and removed as wagons are installed or uninstalled. After you have added a wagon's gem to your production
-+Wagonfile+, run <tt>rake wagon:setup</tt> to run the migrations and load the seed data. Before you remove them
-from +Wagonfile+, run <tt>rake wagon:remove WAGON=to_remove</tt> to eliminate the artifacts from the database first.
-
-In this way, the +schema.rb+ file must only contain the tables of the application, not of all wagons.
-When you have migrations for your main application and wagons loaded, the schema will not be dumped on
-<tt>db:migrate</tt>. You need to either remove the wagons or reset the database before the schema may be dumped.
-This is (currently) the cost for having arbitrary pluggable application extensions.
-
-=== Tests
-
-Wagons use your application for tests. This is also true for your application's test database. To get the
-correct setup, <tt>app:db:test:prepare</tt> is extended to run the migration of the current wagon and all its
-dependencies, as well as their seed data. Once the database is set up, single tests may be run with
-the usual <tt>ruby -I test test/my_test.rb</tt> command.
-
-The +test_helper.rb+ of the main application is included in all wagon tests. Any additions in
-this file are available in wagon tests as well. The only thing wagons need to do is reseting the
-fixture path to the wagon's test fixtures.
-
-RSpec works fine with wagons as well. Simply put the heading lines found in <tt>test_helper.rb</tt> into your
-<tt>spec_helper.rb</tt>.
-
-=== Gem Bundling
-
-Bundler manages application dependencies, with a stress on application. Because wagons live
-inside your application during development, the app's +Gemfile+ is included in each wagon's +Gemfile+.
-However, Bundler still keeps a separate <tt>Gemfile.lock</tt> for each wagon, so you have to make sure to keep
-these up to date when you change your main application gems. The gem versions for the wagons should be
-the same as for the application. <tt>rake wagon:bundle:update</tt> is here to help you exactly with that.
-We recommend to NOT check in the Wagon's <tt>Gemfile.lock</tt> file into source control.
-
-Unfortunately, adding wagon gems to the +Wagonfile+ in production also breaks with Bundler's approach
-of locking down application gems. Because of that, the <tt>--deployment</tt> option cannot be used
-with wagons. If you install your gems from <tt>vendor/cache</tt> into <tt>vendor/bundle</tt> or so,
-you still get most of the benefits of using Bundler, including the guarantee for the very same gem
-versions as used in development.
-
-Contributions to this or any other issues are very welcome.

data/test/ci/rails52.gemfile

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec :path => '../..'
-
-gem 'rails', '~> 5.2.0'
-
-group :test do
-  gem 'mocha', :require => false
-  gem 'rails-controller-testing'
-end

data/test/ci/rails52.gemfile.lock

@@ -1,142 +0,0 @@
-PATH
-  remote: ../..
-  specs:
-    wagons (0.6.1)
-      bundler (>= 1.1)
-      rails (>= 5.2)
-      seed-fu-ndo (>= 0.0.3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actioncable (5.2.8.1)
-      actionpack (= 5.2.8.1)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailer (5.2.8.1)
-      actionpack (= 5.2.8.1)
-      actionview (= 5.2.8.1)
-      activejob (= 5.2.8.1)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (5.2.8.1)
-      actionview (= 5.2.8.1)
-      activesupport (= 5.2.8.1)
-      rack (~> 2.0, >= 2.0.8)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.8.1)
-      activesupport (= 5.2.8.1)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.8.1)
-      activesupport (= 5.2.8.1)
-      globalid (>= 0.3.6)
-    activemodel (5.2.8.1)
-      activesupport (= 5.2.8.1)
-    activerecord (5.2.8.1)
-      activemodel (= 5.2.8.1)
-      activesupport (= 5.2.8.1)
-      arel (>= 9.0)
-    activestorage (5.2.8.1)
-      actionpack (= 5.2.8.1)
-      activerecord (= 5.2.8.1)
-      marcel (~> 1.0.0)
-    activesupport (5.2.8.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    arel (9.0.0)
-    builder (3.2.4)
-    concurrent-ruby (1.1.10)
-    crass (1.0.6)
-    erubi (1.11.0)
-    globalid (1.0.0)
-      activesupport (>= 5.0)
-    i18n (1.12.0)
-      concurrent-ruby (~> 1.0)
-    loofah (2.19.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
-    marcel (1.0.2)
-    method_source (1.0.0)
-    mini_mime (1.1.2)
-    minitest (5.16.3)
-    mocha (1.15.0)
-    nio4r (2.5.8)
-    nokogiri (1.13.8-x86_64-linux)
-      racc (~> 1.4)
-    open4 (1.3.4)
-    racc (1.6.0)
-    rack (2.2.4)
-    rack-test (2.0.2)
-      rack (>= 1.3)
-    rails (5.2.8.1)
-      actioncable (= 5.2.8.1)
-      actionmailer (= 5.2.8.1)
-      actionpack (= 5.2.8.1)
-      actionview (= 5.2.8.1)
-      activejob (= 5.2.8.1)
-      activemodel (= 5.2.8.1)
-      activerecord (= 5.2.8.1)
-      activestorage (= 5.2.8.1)
-      activesupport (= 5.2.8.1)
-      bundler (>= 1.3.0)
-      railties (= 5.2.8.1)
-      sprockets-rails (>= 2.0.0)
-    rails-controller-testing (1.0.5)
-      actionpack (>= 5.0.1.rc1)
-      actionview (>= 5.0.1.rc1)
-      activesupport (>= 5.0.1.rc1)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.3)
-      loofah (~> 2.3)
-    railties (5.2.8.1)
-      actionpack (= 5.2.8.1)
-      activesupport (= 5.2.8.1)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
-    rake (13.0.6)
-    seed-fu (2.3.9)
-      activerecord (>= 3.1)
-      activesupport (>= 3.1)
-    seed-fu-ndo (0.0.3)
-      seed-fu (>= 2.2.0)
-    sprockets (4.1.1)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.4.2)
-      actionpack (>= 5.2)
-      activesupport (>= 5.2)
-      sprockets (>= 3.0.0)
-    sqlite3 (1.5.3-x86_64-linux)
-    thor (1.2.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.10)
-      thread_safe (~> 0.1)
-    websocket-driver (0.7.5)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.5)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  mocha
-  open4
-  rails (~> 5.2.0)
-  rails-controller-testing
-  sqlite3
-  wagons!
-
-BUNDLED WITH
-   2.3.19

data/test/ci/rails60.gemfile.lock

@@ -1,164 +0,0 @@
-PATH
-  remote: ../..
-  specs:
-    wagons (0.6.1)
-      bundler (>= 1.1)
-      rails (>= 5.2)
-      seed-fu-ndo (>= 0.0.3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actioncable (6.0.6)
-      actionpack (= 6.0.6)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.6)
-      actionpack (= 6.0.6)
-      activejob (= 6.0.6)
-      activerecord (= 6.0.6)
-      activestorage (= 6.0.6)
-      activesupport (= 6.0.6)
-      mail (>= 2.7.1)
-    actionmailer (6.0.6)
-      actionpack (= 6.0.6)
-      actionview (= 6.0.6)
-      activejob (= 6.0.6)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (6.0.6)
-      actionview (= 6.0.6)
-      activesupport (= 6.0.6)
-      rack (~> 2.0, >= 2.0.8)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.6)
-      actionpack (= 6.0.6)
-      activerecord (= 6.0.6)
-      activestorage (= 6.0.6)
-      activesupport (= 6.0.6)
-      nokogiri (>= 1.8.5)
-    actionview (6.0.6)
-      activesupport (= 6.0.6)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.6)
-      activesupport (= 6.0.6)
-      globalid (>= 0.3.6)
-    activemodel (6.0.6)
-      activesupport (= 6.0.6)
-    activerecord (6.0.6)
-      activemodel (= 6.0.6)
-      activesupport (= 6.0.6)
-    activestorage (6.0.6)
-      actionpack (= 6.0.6)
-      activejob (= 6.0.6)
-      activerecord (= 6.0.6)
-      marcel (~> 1.0)
-    activesupport (6.0.6)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    builder (3.2.4)
-    concurrent-ruby (1.1.10)
-    crass (1.0.6)
-    erubi (1.11.0)
-    globalid (1.0.0)
-      activesupport (>= 5.0)
-    i18n (1.12.0)
-      concurrent-ruby (~> 1.0)
-    loofah (2.19.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
-    marcel (1.0.2)
-    method_source (1.0.0)
-    mini_mime (1.1.2)
-    minitest (5.16.3)
-    mocha (1.15.0)
-    net-protocol (0.1.3)
-      timeout
-    net-smtp (0.3.2)
-      net-protocol
-    nio4r (2.5.8)
-    nokogiri (1.13.8-x86_64-linux)
-      racc (~> 1.4)
-    open4 (1.3.4)
-    racc (1.6.0)
-    rack (2.2.4)
-    rack-test (2.0.2)
-      rack (>= 1.3)
-    rails (6.0.6)
-      actioncable (= 6.0.6)
-      actionmailbox (= 6.0.6)
-      actionmailer (= 6.0.6)
-      actionpack (= 6.0.6)
-      actiontext (= 6.0.6)
-      actionview (= 6.0.6)
-      activejob (= 6.0.6)
-      activemodel (= 6.0.6)
-      activerecord (= 6.0.6)
-      activestorage (= 6.0.6)
-      activesupport (= 6.0.6)
-      bundler (>= 1.3.0)
-      railties (= 6.0.6)
-      sprockets-rails (>= 2.0.0)
-    rails-controller-testing (1.0.5)
-      actionpack (>= 5.0.1.rc1)
-      actionview (>= 5.0.1.rc1)
-      activesupport (>= 5.0.1.rc1)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.3)
-      loofah (~> 2.3)
-    railties (6.0.6)
-      actionpack (= 6.0.6)
-      activesupport (= 6.0.6)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
-    rake (13.0.6)
-    seed-fu (2.3.9)
-      activerecord (>= 3.1)
-      activesupport (>= 3.1)
-    seed-fu-ndo (0.0.3)
-      seed-fu (>= 2.2.0)
-    sprockets (4.1.1)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.4.2)
-      actionpack (>= 5.2)
-      activesupport (>= 5.2)
-      sprockets (>= 3.0.0)
-    sqlite3 (1.5.3-x86_64-linux)
-    thor (1.2.1)
-    thread_safe (0.3.6)
-    timeout (0.3.0)
-    tzinfo (1.2.10)
-      thread_safe (~> 0.1)
-    websocket-driver (0.7.5)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.5)
-    zeitwerk (2.6.1)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  mocha
-  net-smtp
-  open4
-  rails (~> 6.0.0)
-  rails-controller-testing
-  sqlite3
-  wagons!
-
-BUNDLED WITH
-   2.3.19

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -1,7 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
-# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
-
-# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
-# Rails.backtrace_cleaner.remove_silencers!

data/test/dummy/config/initializers/inflections.rb

@@ -1,15 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# Add new inflection rules using the following format
-# (all these examples are active by default):
-# ActiveSupport::Inflector.inflections do |inflect|
-#   inflect.plural /^(ox)$/i, '\1en'
-#   inflect.singular /^(ox)en/i, '\1'
-#   inflect.irregular 'person', 'people'
-#   inflect.uncountable %w( fish sheep )
-# end
-#
-# These inflection rules are supported but not enabled by default:
-# ActiveSupport::Inflector.inflections do |inflect|
-#   inflect.acronym 'RESTful'
-# end

data/test/dummy/config/initializers/mime_types.rb

@@ -1,5 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# Add new mime types for use in respond_to blocks:
-# Mime::Type.register "text/richtext", :rtf
-# Mime::Type.register_alias "text/html", :iphone