stationed 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddd733df0111d69ab25025b8cd2cd21d46b5df23
-  data.tar.gz: b1574b28a98ef141d8b7b1354f07848edc6f3c87
+  metadata.gz: f8a940b7b782fd708f9dbdb1b3e10d3507fb44d8
+  data.tar.gz: 7e1aea4eec20e7d767922eda2ba8f637b59367dc
 SHA512:
-  metadata.gz: b658a1b9f224f88cd45eefd99a32e3a1b942d22c5e958b995f08d3840dd1dff4c228172fa2d290251b64b787e50b04de8669258122c447f2b9e959ad13bfa486
-  data.tar.gz: 40ab1e4c1ca98273577df0f1e0235aa1ccec4df7dac8e1e344d3a64625efd762252fb52d72a81073b2660c6001af17373f5521e38f3697878afeef5e84ec476b
+  metadata.gz: 023db417672a5477980cf5b8c1f2049a09d7a4356d4ce086cb6d74eff4064d6e85dd0c0e23819c07440ca44ae5629ad1eec133027ab295eec48c693e33c0234b
+  data.tar.gz: 0ef4a07defd85264ff48e1195db0c74a79f46ed166cb1565e75880e31ca141916941f5ee89677bf3d2e5ad5b573b185894f14117045703b0e00a49fa5c92f26d

data/README.md

@@ -99,6 +99,27 @@ methods for `new`, `edit`, `show`, `destroy` and `index`, in the variants
 `link_to`, `button_to` and `button_link_to` (for links with a `button` class
 name).
 
+### Placeholders
+
+Display a placeholder message using standardized markup and a message defined
+through I18n.
+
+When in a controller PostsController and action index, this will try to look up
+the following placeholder keys:
+
+* placeholders.posts.index
+* placeholders.posts.default
+* placeholders.defaults.index
+
+You can also provide an argument to set the placeholder message. When given a
+string, it will be used directly as the placeholder message. When given a
+symbol, that key will be looked up in the `placeholders.defaults` namespace
+using I18n.
+
+For example:
+
+    placeholder('Nothing found') # => '<p class="placeholder">Nothing found</p>'
+
 ### Templates
 
 Stationed includes customized scaffold templates for Haml, Rspec and

data/app/helpers/placeholder_helper.rb

@@ -0,0 +1,45 @@
+# Provides the `placeholder` helper method for showing standard markup
+# for when thing are missing or not present yet.
+module PlaceholderHelper
+  # Display a placeholder message using standardized markup and a message
+  # defined through I18n.
+  #
+  # When in a controller PostsController and action index, this will try
+  # to look up the following placeholder keys:
+  #
+  # * placeholders.posts.index
+  # * placeholders.posts.default
+  # * placeholders.defaults.index
+  #
+  # You can also provide an argument to set the placeholder message. When given
+  # a string, it will be used directly as the placeholder message. When given a
+  # symbol, that key will be looked up in the `placeholders.defaults` namespace
+  # using I18n.
+  #
+  # @return [String] e.g. '<p class="placeholder">Nothing to show</p>'
+  def placeholder(label = nil, tag: :p)
+    content_tag(tag, placeholder_text(label), class: 'placeholder')
+  end
+
+  private
+
+  def placeholder_text(label)
+    case label
+    when Symbol
+      defaults = [
+        :"placeholders.defaults.#{label}",
+        :'placeholders.defaults.default'
+      ]
+      translate(defaults.shift, default: defaults)
+    when nil
+      defaults = [
+        :"placeholders.#{controller_name}.#{action_name}",
+        :"placeholders.#{controller_name}.default",
+        :"placeholders.defaults.#{action_name}"
+      ]
+      translate defaults.shift, default: defaults
+    else
+      label.to_s
+    end
+  end
+end

data/lib/stationed/generators/plugins/devise.rb

@@ -15,10 +15,10 @@ module Stationed
           copy_file 'devise.rb', 'spec/support/devise.rb' if options[:rspec]
           route "devise_scope :user do\n    root to: 'devise/sessions#new'\n  end\n"
           environment nil, env: :test do
-            "config.action_mailer.default_url_options = { host: 'example.com' }"
+            "# Set default url options for Devise mailers\n  config.action_mailer.default_url_options = { host: 'example.com' }\n"
           end
           environment nil, env: :development do
-            "config.action_mailer.default_url_options = { host: 'localhost:3000' }"
+            "# Set default url options for Devise mailers\n  config.action_mailer.default_url_options = { host: 'localhost:3000' }\n"
           end
           super
         end

data/lib/stationed/generators/plugins/i18n_spec.rb

@@ -13,6 +13,8 @@ module Stationed
           return super unless options[:i18n_spec]
           gem 'i18n-spec', group: :test
           copy_file 'i18n_spec.rb', 'spec/locales/i18n_spec.rb'
+          uncomment_lines 'config/environments/development.rb', /raise_on_missing_translations/
+          uncomment_lines 'config/environments/test.rb', /raise_on_missing_translations/
           super
         end
       end

data/lib/stationed/generators/plugins/strong_parameters.rb

@@ -14,8 +14,8 @@ module Stationed
           environment nil, env: :development do
             <<-RUBY
 # Raise an ActionController::UnpermittedParameters exception when
-# a parameter is not explcitly permitted but is passed anyway.
-config.action_controller.action_on_unpermitted_parameters = :raise
+  # a parameter is not explcitly permitted but is passed anyway.
+  config.action_controller.action_on_unpermitted_parameters = :raise
             RUBY
           end
           super

data/lib/stationed/generators/plugins/yard.rb

@@ -14,6 +14,7 @@ module Stationed
           gem 'yard', require: false, group: :doc
           gem 'kramdown', require: false, group: :doc
           copy_file 'yardopts', '.yardopts'
+          copy_file 'yard.rake', 'lib/tasks/yard.rake'
           super
         end
       end

data/lib/stationed/generators/templates/yard.rake

@@ -0,0 +1,7 @@
+begin
+  require 'yard'
+  namespace :doc do
+    YARD::Rake::YardocTask.new
+  end
+rescue LoadError
+end

data/lib/stationed/version.rb

@@ -1,3 +1,3 @@
 module Stationed
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'.freeze
 end

data/spec/dummy/log/test.log

@@ -1472,3 +1472,109 @@
    (0.0ms)  rollback transaction
    (0.0ms)  begin transaction
    (0.0ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.2ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction

data/spec/helpers/placeholder_helper_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe PlaceholderHelper do
+  before do
+    allow(helper).to receive(:controller_name).and_return('products')
+    allow(helper).to receive(:action_name).and_return('index')
+  end
+
+  it 'fetches default key by controller action first' do
+    I18n.backend.store_translations :en, placeholders: { products: { index: 'Nothing found' } }
+    expect(helper.placeholder).to eql('<p class="placeholder">Nothing found</p>')
+  end
+
+  it 'fetches default key by controller second' do
+    I18n.backend.store_translations :en, placeholders: { products: { default: 'Nothing found' } }
+    expect(helper.placeholder).to eql('<p class="placeholder">Nothing found</p>')
+  end
+
+  it 'fetches default key by action third' do
+    I18n.backend.store_translations :en, placeholders: { defaults: { index: 'Nothing found' } }
+    expect(helper.placeholder).to eql('<p class="placeholder">Nothing found</p>')
+  end
+
+  it 'fetches custom default key' do
+    I18n.backend.store_translations :en, placeholders: { defaults: { foo: 'Nothing found' } }
+    expect(helper.placeholder(:foo)).to eql('<p class="placeholder">Nothing found</p>')
+  end
+
+  it 'uses plain string' do
+    expect(helper.placeholder('Nothing found')).to eql('<p class="placeholder">Nothing found</p>')
+  end
+
+  it 'allows using a custom tag' do
+    expect(helper.placeholder('Nothing found', tag: :span)).to eql('<span class="placeholder">Nothing found</span>')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stationed
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Arjan van der Gaag
@@ -70,6 +70,7 @@ files:
 - Rakefile
 - app/helpers/crud_link_helper.rb
 - app/helpers/page_title_helper.rb
+- app/helpers/placeholder_helper.rb
 - lib/generators/stationed/templates_generator.rb
 - lib/stationed.rb
 - lib/stationed/app_builder.rb
@@ -143,6 +144,7 @@ files:
 - lib/stationed/generators/templates/spring.rb
 - lib/stationed/generators/templates/static_input.rb
 - lib/stationed/generators/templates/webmock.rb
+- lib/stationed/generators/templates/yard.rake
 - lib/stationed/generators/templates/yardopts
 - lib/stationed/version.rb
 - lib/tasks/stationed_tasks.rake
@@ -196,6 +198,7 @@ files:
 - spec/dummy/public/favicon.ico
 - spec/helpers/crud_link_helper_spec.rb
 - spec/helpers/page_title_helper_spec.rb
+- spec/helpers/placeholder_helper_spec.rb
 - spec/spec_helper.rb
 homepage: http://avdgaag.github.io/stationed
 licenses: []
@@ -257,4 +260,5 @@ test_files:
 - spec/dummy/README.rdoc
 - spec/helpers/crud_link_helper_spec.rb
 - spec/helpers/page_title_helper_spec.rb
+- spec/helpers/placeholder_helper_spec.rb
 - spec/spec_helper.rb