stationed 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38bb78f102e4d35a45d2226d922a0f2c183aa54b
+  data.tar.gz: 312a9980d2168f891695ff3897863a7e69b49a44
+SHA512:
+  metadata.gz: ee86970abab0e607e449ed93c2104579e1bd903769f53245e0b41c38b856c00b1deec5c663e99cd4fb38e715f04f35071a7e1f281b95b37a0bb8eb9d89f16d4e
+  data.tar.gz: d909f871bcbbffb800249f7924ad69ea19921b1ce279c99d931b73b03f162100d51fc4a646b1f2d8e57d65da98bd010e2f0207aa54896f77302a3b61607502cc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,136 @@
+# Stationed
+
+## Introduction
+
+Stationed is an extensive Rails application generator, providing you with a
+starter app full standard goodies such as testing, authentication,
+authorization, decorators, tasks and styles. But as an engine it also provides
+you with customized scaffold generators including proper tests. Finally, it
+provides some basic view helpers that every project tends to need. All in all,
+stationed is pretty sweet.
+
+## Installation
+
+In order to use Stationed to generate applications, install the gem:
+
+    % gem install stationed
+
+To use it as an engine in your Rails application, include it in your Gemfile:
+
+    gem 'stationed'
+
+Run `bundle install` and you're all set.
+
+## Application generator
+
+The application generator is invoked using the `stationed` command:
+
+    % stationed my_app
+
+This will generate a default Rails application with the following additions:
+
+* **Rubocop** for automated style guide testing.
+* **Pry** for debugging.
+* **Guard** for auto-running tests.
+* **Rspec** with Simplecov for testing.
+* **FactoryGirl** for object factories.
+* **DatabaseCleaner** as transaction replacement.
+* **Capybara** for feature testing.
+* **CapybaraWebkit** for headless browser testing.
+* **Pundit** for authorization.
+* **Yard** for API documentation.
+* **Foreman** for process management.
+* **Bourbon, Neat and Bitters and normalize.css** for styling.
+* **Draper** for decorators.
+* **Gollum** for a built-in development wiki.
+* **Devise** for authentication.
+* **Turbolinks** removed.
+* **Kaminari** for pagination.
+* **SimpleForm** for awesome form markup.
+* **Haml** for pretty view templates.
+* **Webmock** to disallow external HTTP requests in tests.
+* **I18nSpec** for automated validation of locale files.
+* **Responders** for DRY controllers.
+
+...and some other minor configurations and goodies.
+
+All these additions are stand-alone "plugins" for the base application
+generator, so it is easy to adapt them or add others. Have a look at
+`lib/stationed/generators/plugins` to see all plugins.
+
+## Helpers
+
+### Page title
+
+The page title helper allows you to set a page title based on a string,
+translation key or by a resource. You can easily output it on your page and in
+your layout.
+
+* When given no argument, this will return the currently set page title or
+  the site-wide default.
+* When given a string argument, that will be used in the formatted page
+  title (for example with a site-wide suffix).
+* When given an ActiveModel-compliant object, its singular and plural human
+  names will be interpolated into the model-based title template, along
+  with the record's ID.
+
+You can provide templates for page titles using `I18n` in three broad
+categories: the `model`, `formatted` and `standard` keys. These will be used
+when you set a page title via a model, string or nothing at all, respectively.
+
+You can specify these translation keys on a global default level, per controller
+or per controller action. The more specific key will take precedence.
+
+### CRUD link helpers
+
+A collection of helper methods to generate links to CRUD operations with labels
+and URLs generated by resources.
+
+For example:
+
+    link_to_new(Post) # => <a href="/posts/new">New Post</a>
+    link_to_edit(@product) # => <a href="/products/1/edit">Edit Product 1</a>
+
+You can use I18n to fully customize the labels on these links. There are helper
+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).
+
+### Templates
+
+Stationed includes customized scaffold templates for Haml, Rspec and
+controllers. These work out of the box, but you can use a generator to install
+the templates into your application for easy customization:
+
+    rails generate stationed:templates
+
+## Other
+
+### Note on Patches/Pull Requests
+
+1. Fork the project.
+2. Make your feature addition or bug fix.
+3. Add tests for it. This is important so I don't break it in a future version
+   unintentionally.
+4. Commit, do not mess with rakefile, version, or history. (if you want to have
+   your own version, that is fine but bump version in a commit by itself I can
+   ignore when I pull)
+5. Send me a pull request. Bonus points for topic branches.
+
+### Issues
+
+Please report any issues, defects or suggestions in the [Github issue
+tracker](https://github.com/avdgaag/stationed/issues).
+
+### What has changed?
+
+See the [HISTORY](https://github.com/avdgaag/stationed/blob/master/HISTORY.md) file for a detailed changelog.
+
+### Credits
+
+Created by: Arjan van der Gaag  
+URL: [http://arjanvandergaag.nl](http://arjanvandergaag.nl)  
+Project homepage:
+[http://avdgaag.github.com/rpub](http://avdgaag.github.com/stationed)  
+Date: april 2014  
+License: [MIT-license](https://github.com/avdgaag/stationed/LICENSE) (same as Ruby)

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Stationed'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+task default: :spec

data/app/helpers/crud_link_helper.rb

@@ -0,0 +1,22 @@
+require 'stationed/crud_tag'
+
+# Provides links to CRUD-style operations for resources.
+#
+# @see CrudTag
+module CrudLinkHelper
+  %i(new edit show index destroy).each do |action|
+    define_method :"link_to_#{action}" do |*args|
+      Stationed::CrudTag.new(self, :link_to, *args).send action
+    end
+
+    define_method :"button_to_#{action}" do |*args|
+      Stationed::CrudTag.new(self, :button_to, *args).send action
+    end
+
+    define_method :"button_link_to_#{action}" do |*args|
+      options = args.extract_options!
+      options.reverse_merge! class: 'button'
+      Stationed::CrudTag.new(self, :link_to, *args, options).send action
+    end
+  end
+end

data/app/helpers/page_title_helper.rb

@@ -0,0 +1,107 @@
+module PageTitleHelper
+  # Sets or retrieves the current page title.
+  #
+  # * When given no argument, this will return the currently set page title or
+  #   the site-wide default.
+  # * When given a string argument, that will be used in the formatted page
+  #   title (for example with a site-wide suffix).
+  # * When given an ActiveModel-compliant object, its singular and plural human
+  #   names will be interpolated into the model-based title template, along
+  #   with the record's ID.
+  #
+  # You can provide templates for page titles using `I18n` in three broad
+  # categories: the `model`, `formatted` and `standard` keys. These will be
+  # used when you set a page title via a model, string or nothing at all,
+  # respectively.
+  #
+  # You can specify these translation keys on a global default level, per
+  # controller or per controller action. The more specific key will take
+  # precedence.
+  #
+  # @example Set the page title to a string
+  #   page_title 'Welcome'
+  # @example Set the page title based on a model name
+  #   page_title Post.find(1)
+  #   # example translation key: 'Editing %{singular} %{id}'
+  # @example Show the page title
+  #   <title><%= title %></title>
+  #
+  # @param [String, #model_name] String or ActiveModel-compliant object
+  # @return [String] page title component or formatted page title
+  def page_title(new_title = nil)
+    if new_title
+      title_from_string_or_record_or_class(new_title).tap do |str|
+        content_for :page_title, str
+      end
+    elsif content_for? :page_title
+      formatted_title
+    else
+      standard_title
+    end
+  end
+
+  private
+
+  def standard_title
+    I18n.translate(
+      standard_defaults.first,
+      default: standard_defaults.drop(1)
+    )
+  end
+
+  def formatted_title
+    I18n.translate(
+      formatted_defaults.first,
+      title:   content_for(:page_title),
+      default: formatted_defaults.drop(1)
+    )
+  end
+
+  def title_for_class(klass, options = {})
+    options.reverse_merge!(
+      default:  model_defaults.drop(1),
+      singular: klass.model_name.human,
+      plural:   klass.model_name.human.pluralize
+    )
+    I18n.translate model_defaults.first, options
+  end
+
+  def title_from_string_or_record_or_class(object)
+    if object.respond_to?(:model_name)
+      title_for_class(object)
+    elsif object.class.respond_to?(:model_name)
+      title_for_class(object.class, id: object.to_param)
+    else
+      object
+    end
+  end
+
+  def formatted_defaults
+    [
+      :"page_title.#{controller_name}.#{action_name}.formatted",
+      :"page_title.#{controller_name}.formatted",
+      :'page_title.default.formatted',
+      :'page_title.default.standard',
+      ::Rails.application.class.parent_name
+    ]
+  end
+
+  def standard_defaults
+    [
+      :"page_title.#{controller_name}.#{action_name}.standard",
+      :"page_title.#{controller_name}.standard",
+      :'page_title.default.standard',
+      ::Rails.application.class.parent_name
+    ]
+  end
+
+  def model_defaults
+    [
+      :"page_title.#{controller_name}.#{action_name}.model",
+      :"page_title.#{controller_name}.model",
+      :'page_title.default.model',
+      :'page_title.default.standard',
+      ::Rails.application.class.parent_name
+    ]
+  end
+end

data/lib/generators/stationed/templates_generator.rb

@@ -0,0 +1,24 @@
+module Stationed
+  module Generators
+    class TemplatesGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../../templates', __FILE__)
+
+      def self.banner
+        <<-BANNER.chomp
+rails generate stationed:templates
+
+Copies all generator templates from the Stationed gem into your project
+directory for easy customisation.
+        BANNER
+      end
+
+      def copy_files
+        root = Pathname(self.class.source_root)
+        Pathname.glob(root.join('**', '*.{haml,rb}')).each do |path|
+          relpath = path.relative_path_from(root)
+          copy_file relpath, Pathname('lib/templates').join(relpath)
+        end
+      end
+    end
+  end
+end

data/lib/stationed/app_builder.rb

@@ -0,0 +1,13 @@
+module Stationed
+  class AppBuilder < Rails::AppBuilder
+    def readme
+      template 'README.md.erb', 'README.md'
+    end
+
+    def database_yml
+      super
+      append_to_file '.gitignore', "config/database.yml\n"
+      template "config/databases/#{options[:database]}.yml", "config/database.yml.example"
+    end
+  end
+end

data/lib/stationed/crud_tag.rb

@@ -0,0 +1,70 @@
+module Stationed
+  # Base class for CRUD-style tags
+  class CrudTag
+    attr_reader :context, :method, :resource, :model
+
+    def initialize(context, method, resource, options = {})
+      @context  = context
+      @method   = method
+      @resource = resource
+      @model    = Array(resource).last
+      @options  = options
+    end
+
+    def index
+      context.send method, label(:index), model, options
+    end
+
+    def new
+      *nested_parts, _ = Array(resource)
+      context.send method, label(:new), [:new, *nested_parts, model_name.singular], options
+    end
+
+    def show
+      context.send method, label(:show), [*resource], options
+    end
+
+    def edit
+      context.send method, label(:edit), [:edit, *resource], options
+    end
+
+    def destroy
+      context.send method, label(:destroy), [*resource], options.merge(data: { method: :delete })
+    end
+
+    private
+
+    def options
+      default_options.merge(@options)
+    end
+
+    def model_name
+      @model_name ||=
+        if @model.respond_to?(:model_name)
+          @model.model_name
+        elsif @model.class.respond_to?(:model_name)
+          @model.class.model_name
+        else
+          fail ArgumentError,
+               'Pass in an ActiveModel-compliant record or class'
+        end
+    end
+
+    def default_options
+      {}
+    end
+
+    def label(action)
+      context.translate(
+        :"helpers.buttons.#{model_name.i18n_key}.#{action}",
+        default: [
+          :"helpers.buttons.defaults.#{action}",
+          "#{action.capitalize} %{model}"
+        ],
+        model: model_name.human,
+        plural: model_name.human.pluralize,
+        id: model.to_param
+      )
+    end
+  end
+end

data/lib/stationed/engine.rb

@@ -0,0 +1,8 @@
+module Stationed
+  class Engine < ::Rails::Engine
+    config.app_generators do |g|
+      g.templates.unshift File.expand_path('../../templates', __FILE__)
+      g.scaffold_controller :scaffold_controller
+    end
+  end
+end

data/lib/stationed/generators/app_generator.rb

@@ -0,0 +1,52 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+require 'stationed/app_builder'
+require 'stationed/generators/plugins'
+
+module Stationed
+  module Generators
+    class AppGenerator < Rails::Generators::AppGenerator
+      source_root File.expand_path('../templates', __FILE__)
+      source_paths << Rails::Generators::AppGenerator.source_root
+      source_paths << source_root
+
+      prepend Plugins::Rubocop
+      prepend Plugins::Pry
+      prepend Plugins::Guard
+      prepend Plugins::Rspec
+      prepend Plugins::FactoryGirl
+      prepend Plugins::DatabaseCleaner
+      prepend Plugins::Capybara
+      prepend Plugins::CapybaraWebkit
+      prepend Plugins::Pundit
+      prepend Plugins::Yard
+      prepend Plugins::Foreman
+      prepend Plugins::Styles
+      prepend Plugins::Draper
+      prepend Plugins::Wiki
+      prepend Plugins::Generators
+      prepend Plugins::Devise
+      prepend Plugins::Turbolinks
+      prepend Plugins::Kaminari
+      prepend Plugins::SimpleForm
+      prepend Plugins::Haml
+      prepend Plugins::StrongParameters
+      prepend Plugins::RackDeflater
+      prepend Plugins::Flashes
+      prepend Plugins::Webmock
+      prepend Plugins::Layout
+      prepend Plugins::Normalize
+      prepend Plugins::I18nSpec
+      prepend Plugins::SimpleFormInputs
+      prepend Plugins::Spring
+      prepend Plugins::Stationed
+      prepend Plugins::Responders
+
+      protected
+
+      def get_builder_class
+        Stationed::AppBuilder
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Stationed
+  module Generators
+    module Plugins
+      module Capybara
+        def finish_template
+          gem 'capybara', group: :test
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Stationed
+  module Generators
+    module Plugins
+      module CapybaraWebkit
+        def finish_template
+          gem 'capybara-webkit', group: :test
+          copy_file 'capybara_webkit.rb', 'spec/support/capybara_webkit.rb'
+          super
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,13 @@
+module Stationed
+  module Generators
+    module Plugins
+      module DatabaseCleaner
+        def finish_template
+          gem 'database_cleaner', group: :test
+          copy_file 'database_cleaner.rb', 'spec/support/database_cleaner.rb'
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module Stationed
+  module Generators
+    module Plugins
+      module Devise
+        def finish_template
+          gem 'devise'
+          copy_file 'devise.rb', 'spec/support/devise.rb'
+          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' }"
+          end
+          environment nil, env: :development do
+            "config.action_mailer.default_url_options = { host: 'localhost:3000' }"
+          end
+          super
+        end
+
+        def run_bundle
+          super
+          generate 'devise:install'
+          generate 'devise user'
+          application do
+            <<-RUBY
+# Let Pundit authorization or custom responders not influence the workings
+    # of Devise.
+    config.to_prepare do
+      [
+        Devise::SessionsController,
+        Devise::RegistrationsController,
+        Devise::PasswordsController
+      ].each do |devise_controller_class|
+        devise_controller_class.skip_after_action :verify_authorized
+        devise_controller_class.skip_after_action :verify_policy_scoped
+        devise_controller_class.responder = ActionController::Responder
+      end
+    end
+            RUBY
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Stationed
+  module Generators
+    module Plugins
+      module Draper
+        def finish_template
+          gem 'draper'
+          copy_file 'application_decorator.rb', 'app/decorators/application_decorator.rb'
+          copy_file 'paginating_decorator.rb', 'app/decorators/paginating_decorator.rb'
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Stationed
+  module Generators
+    module Plugins
+      module FactoryGirl
+        def finish_template
+          gem 'factory_girl_rails', group: [:development, :test]
+          copy_file 'factory_girl.rb', 'spec/support/factory_girl.rb'
+          copy_file 'factories_spec.rb', 'spec/models/factories_spec.rb'
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Stationed
+  module Generators
+    module Plugins
+      module Flashes
+        def finish_template
+          copy_file 'flashes.html.haml', 'app/views/application/_flashes.html.haml'
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Stationed
+  module Generators
+    module Plugins
+      module Foreman
+        def finish_template
+          gem 'foreman'
+          gem 'yard', require: false, group: :doc
+          copy_file 'Procfile', 'Procfile'
+          template 'env.erb', '.env'
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Stationed
+  module Generators
+    module Plugins
+      module Generators
+        def finish_template
+          copy_file 'generators.rb', 'config/initializers/generators.rb'
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Stationed
+  module Generators
+    module Plugins
+      module Guard
+        def finish_template
+          gem_group :development do
+            gem 'guard'
+            gem 'guard-rspec'
+            gem 'guard-livereload'
+            gem 'terminal-notifier-guard'
+          end
+          super
+        end
+
+        def run_bundle
+          super
+          run 'bundle exec guard init rspec'
+          run 'bundle exec guard init livereload'
+          gsub_file 'Guardfile',
+                    /guard :rspec do/,
+                    "guard :rspec, cmd: 'spring rspec' do"
+        end
+      end
+    end
+  end
+end