sal-engine 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bda48f13aeda94fe4fbcb7ff504a4dc7eff8176e
+  data.tar.gz: f6718d3ed2f671dcf910d64f0c1d93d86f206afd
+SHA512:
+  metadata.gz: 269353a1b3606bc05c5ce2402cabddc81b682a03cf56942d64982508255247abe4d230d0f117ca2030ecd110016be39ed27f242a5a77c06802b15451854a3a6e
+  data.tar.gz: 40b706cdc7bc03fcf6474d2727519c063c849b3a7c28b92832b591f8d8a5b35e324ff51f4d3bd3d0464c9f7db4cbfbea05d2acc6170cd0e8d3770dc778a87ade

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Daniel Cruz Horts
+
+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,88 @@
+[![Build Status](https://travis-ci.org/dncrht/sal.svg?branch=master)](https://travis-ci.org/dncrht/sal)
+
+# What is this?
+
+Sal (salt) is what you add to every meal. I add sal to my Rails projects.
+
+I found I always add a particular set of helpers, initializers and generators.
+Better if they're distributed as a Rails engine.
+
+# How does it taste?
+
+## messages_bar helper
+Will render:
+```html
+<div class="alert alert-success">anything</div>
+```
+…if f`lash[:notice]` contains anything.
+
+Will render:
+```html
+ <div class="alert alert-warning">anything</div>
+```
+…if `flash[:alert]` contains anything.
+
+When providing both, `notice` will prevail.
+
+## menu_item helper
+Very handy for navigation menus:
+```erb
+<%= menu_item 'first' %>First option<% end %>
+<%= menu_item 'second', :div %><%= link_to root_path, 'Second option' %><% end %>
+```
+
+Renders:
+```html
+<li class="active">First option<li>
+<div><a href="/">Second option</a><div>
+```
+
+Parameters:
+`menu_item(item, tag)`
+- item: item name
+- tag: `:li` by default
+
+## errors_bar helper
+Will indicate if any model in your form has an error. It supports multiple models
+in case you're combining two entities in the same form (i.e. using `fields_for`):
+```erb
+<%= errors_item @user %>
+```
+
+Renders:
+```html
+ <div class="alert alert-danger">Please correct the highlighted fields.</div>
+```
+
+Parameters:
+`errors_item(model[, model2…])`
+- model: an active record model, or tableless
+- model2: you can provide more than one
+
+## Error messages
+I like to put the error messages right after the field in the form.
+An initializer will patch ActionView::Base to wrap the field with the error message.
+Given a model with an error on, let's say, _title_, we'll get:
+```html
+<div class="has-error">
+  <input type="text" name="title">
+  <span class="help-block">⤷ Title can't be blank.</span>
+</div>
+```
+
+## Generators
+Rails generators are very useful in the initial stages of development to create your admin interfaces.
+In particular:
+- I use bootstrap classes for layout
+- I don't use the _show_ action/view
+- I don't want to autogenerate helper files for every model
+
+To launch this generator:
+```bash
+bundle exec rails generate scaffold MyModel name:string -p --skip-test-framework
+```
+
+## Interesting, but…
+
+It _fits my purposes_, which may be different from yours. You might like the idea
+though: then fork it and call it **peppermint**, **curry** or whatever you prefer!

data/Rakefile

@@ -0,0 +1,21 @@
+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    = 'Sal'
+  rdoc.options << '--line-numbers'
+  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

data/app/helpers/sal/application_helper.rb

@@ -0,0 +1,32 @@
+module Sal
+  module ApplicationHelper
+    def errors_bar(*entities)
+      entities = Array(entities)
+
+      if entities.detect { |entity| entity.errors.any? }
+        content_tag :div, 'Please correct the highlighted fields.', class: 'alert alert-danger'
+      end
+    end
+
+    def messages_bar
+      if notice
+        content_tag :div, notice.html_safe, class: 'alert alert-success'
+      elsif alert
+        content_tag :div, alert.html_safe, class: 'alert alert-warning'
+      end
+    end
+
+    def menu_item(item, tag = :li)
+      options = section == item ? {class: 'active'} : {}
+      content_tag tag, options do
+        yield
+      end
+    end
+
+    private
+
+    def section
+      content_for(:menu) ? content_for(:menu).strip.downcase : request.params[:controller]
+    end
+  end
+end

data/app/views/layouts/sal/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Sal</title>
+  <%= stylesheet_link_tag    "sal/application", media: "all" %>
+  <%= javascript_include_tag "sal/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/error_span.rb

@@ -0,0 +1,9 @@
+ActionView::Base.field_error_proc = Proc.new do |html_tag, instance|
+  message = Array(instance.error_message).join(', ')
+
+  if html_tag =~ /class="checkbox"/ || ((html_tag !~ /type="checkbox"/) && (html_tag !~ /label/))
+    %(<div class="has-error">#{html_tag}<span class="help-block">⤷ #{message}</span></div>).html_safe
+  else
+    %(<div class="has-error">#{html_tag}</div>).html_safe
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Sal::Engine.routes.draw do
+end

data/lib/generators/rails/helperless_scaffold_controller/helperless_scaffold_controller_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators/resource_helpers'
+
+module Rails
+  class HelperlessScaffoldControllerGenerator < Rails::Generators::NamedBase
+    include Rails::Generators::ResourceHelpers
+
+    check_class_collision suffix: "Controller"
+
+    class_option :orm, banner: "NAME", type: :string, required: true,
+                       desc: "ORM to generate the controller for"
+
+    argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+    def create_controller_files
+      template "controller.rb", File.join('app/controllers', controller_class_path, "#{controller_file_name}_controller.rb")
+    end
+
+    def self.source_root
+      @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+    end
+
+    hook_for :template_engine, :test_framework, as: :scaffold
+  end
+end

data/lib/generators/rails/helperless_scaffold_controller/templates/controller.rb

@@ -0,0 +1,62 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_file_path %>/application_controller"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  before_action :set_<%= singular_table_name %>, only: [:edit, :update, :destroy]
+
+  # GET <%= route_url %>
+  def index
+    @<%= plural_table_name %> = <%= orm_class.all(class_name) %>
+  end
+
+  # GET <%= route_url %>/new
+  def new
+    @<%= singular_table_name %> = <%= orm_class.build(class_name) %>
+  end
+
+  # GET <%= route_url %>/1/edit
+  def edit; end
+
+  # POST <%= route_url %>
+  def create
+    @<%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
+
+    if @<%= orm_instance.save %>
+      redirect_to <%= index_helper %>_path, notice: <%= "'#{human_name} was successfully created.'" %>
+    else
+      render :new
+    end
+  end
+
+  # PATCH/PUT <%= route_url %>/1
+  def update
+    if @<%= orm_instance.update("#{singular_table_name}_params") %>
+      redirect_to <%= index_helper %>_path, notice: <%= "'#{human_name} was successfully updated.'" %>
+    else
+      render :edit
+    end
+  end
+
+  # DELETE <%= route_url %>/1
+  def destroy
+    @<%= orm_instance.destroy %>
+    redirect_to <%= index_helper %>_path, notice: <%= "'#{human_name} was successfully destroyed.'" %>
+  end
+
+  private
+
+  def set_<%= singular_table_name %>
+    @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+  end
+
+  def <%= "#{singular_table_name}_params" %>
+    <%- if attributes_names.empty? -%>
+    params[:<%= singular_table_name %>]
+    <%- else -%>
+    params.require(:<%= singular_table_name %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
+    <%- end -%>
+  end
+end
+<% end -%>

data/lib/generators/rails/showless_scaffold/showless_scaffold_generator.rb

@@ -0,0 +1,33 @@
+require 'rails/generators/erb'
+require 'rails/generators/resource_helpers'
+
+module Rails
+  class ShowlessScaffoldGenerator < Erb::Generators::Base
+    include Rails::Generators::ResourceHelpers
+
+    argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+    def create_root_folder
+      empty_directory File.join("app/views", controller_file_path)
+    end
+
+    def copy_view_files
+      available_views.each do |view|
+        formats.each do |format|
+          filename = filename_with_extensions(view, format)
+          template filename, File.join("app/views", controller_file_path, filename)
+        end
+      end
+    end
+
+    def self.source_root
+      @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+    end
+
+    protected
+
+    def available_views
+      %w(index edit new _form)
+    end
+  end
+end

data/lib/generators/rails/showless_scaffold/templates/_form.html.erb

@@ -0,0 +1,32 @@
+<%%= form_for(@<%= singular_table_name %>) do |f| %>
+  <%%= errors_bar @<%= singular_table_name %> %>
+  <div class="row">
+    <div class="col-sm-8">
+
+<% attributes.each do |attribute| -%>
+      <div class="form-group">
+<% if attribute.password_digest? -%>
+        <%%= f.label :password %>
+        <%%= f.password_field :password, class: 'form-control' %>
+      </div>
+      <div>
+        <%%= f.label :password_confirmation %>
+        <%%= f.password_field :password_confirmation, class: 'form-control' %>
+<% else -%>
+  <%- if attribute.reference? -%>
+        <%%= f.label :<%= attribute.column_name %> %>
+        <%%= f.<%= attribute.field_type %> :<%= attribute.column_name %>, class: 'form-control' %>
+  <%- else -%>
+        <%%= f.label :<%= attribute.name %> %>
+        <%%= f.<%= attribute.field_type %> :<%= attribute.name %>, class: 'form-control' %>
+  <%- end -%>
+<% end -%>
+      </div>
+
+<% end -%>
+    </div>
+  </div>
+
+  <%%= f.submit 'Save', class: 'btn btn-primary' %>
+  <%%= link_to 'Cancel', <%= index_helper %>_path, class: 'btn btn-default' %>
+<%% end %>

data/lib/generators/rails/showless_scaffold/templates/edit.html.erb

@@ -0,0 +1,3 @@
+<h2>Editing <%= singular_table_name %></h2>
+
+<%%= render 'form' %>

data/lib/generators/rails/showless_scaffold/templates/index.html.erb

@@ -0,0 +1,28 @@
+<%%= messages_bar %>
+
+<p>
+  <%%= link_to 'New <%= singular_table_name %>', new_<%= singular_table_name %>_path, class: 'btn btn-default' %>
+</p>
+
+<table class="table table-striped table-bordered">
+  <thead>
+    <tr>
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+      <th><%= attribute.human_name %></th>
+<% end -%>
+      <th colspan="2"></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <%% @<%= plural_table_name %>.each do |<%= singular_table_name %>| %>
+      <tr>
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+        <td><%%= <%= singular_table_name %>.<%= attribute.name %> %></td>
+<% end -%>
+        <td><%%= link_to 'Edit', edit_<%= singular_table_name %>_path(<%= singular_table_name %>) %></td>
+        <td><%%= link_to 'Destroy', <%= singular_table_name %>, method: :delete, data: {confirm: 'Are you sure?'} %></td>
+      </tr>
+    <%% end %>
+  </tbody>
+</table>

data/lib/generators/rails/showless_scaffold/templates/new.html.erb

@@ -0,0 +1,3 @@
+<h2>New <%= singular_table_name %></h2>
+
+<%%= render 'form' %>

data/lib/sal/engine.rb

@@ -0,0 +1,13 @@
+module Sal
+  class Engine < ::Rails::Engine
+    # We want all the helpers to be used in the app
+    #isolate_namespace Sal
+
+    config.app_generators do |g|
+      g.template_engine :showless_scaffold
+      g.scaffold_controller :helperless_scaffold_controller
+      g.stylesheets false
+      g.javascripts false
+    end
+  end
+end

data/lib/sal/version.rb

@@ -0,0 +1,3 @@
+module Sal
+  VERSION = '0.0.1'
+end

data/lib/sal.rb

@@ -0,0 +1,4 @@
+require "sal/engine"
+
+module Sal
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/tableless.rb

@@ -0,0 +1,19 @@
+class Tableless
+  include ActiveModel::Validations
+  include ActiveModel::Conversion
+  extend ActiveModel::Naming
+
+  attr_accessor :title
+
+  validates :title, presence: true
+
+  def initialize(attributes = {})
+    attributes.each do |name, value|
+      send("#{name}=", value)
+    end
+  end
+
+  def persisted?
+    false
+  end
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config/application.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../boot', __FILE__)
+
+#require 'rails/all'
+require "active_model/railtie"
+#require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+#require "sprockets/railtie"
+
+Bundler.require(*Rails.groups)
+require "sal"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end