wobapphelpers 3.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad34edf1a5b43d0676b3d41201de77495d6d262b
+  data.tar.gz: 98a713a4a5e0f5819c4eca403ca7f945047a89e4
+SHA512:
+  metadata.gz: b7c1b1268b553bcbeaf501060e45807d01e09969b6eae1633eea4191c8c8adc85d28113fa3c695c79b9c9f9217773b0487ae32d018e6836dcd7dd241ed275f52
+  data.tar.gz: 790f9781a9172aca798029c331e598d127bc48b562964fcc99b83888871addfc7155ced9317f19410089f2a9a9a2f2ecca17f3c3bae5e6e24e41a02f4cf8ab85

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2018 Wolfgang Barth
+
+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,155 @@
+wobapphelpers
+=============
+
+Rails helpers and more shared between common wob rails applications. Depends on twitter bootstrap. 
+
+This is the ''master'' branch, for use with rails 5.1.
+
+Requirements
+------------
+
+| branch     | rails | ruby   | bootstrap | icons       | 
+|------------|-------|--------|-----------|-------------|
+| master     | 5.1   | >= 2.3 | v4        | fontawesome |
+| 2-0-stable | 5.0   | >= 2.2 | v3        | glyphicons  |        
+| 1-0-stable | 4.2   | >= 2.0 | v3        | glyphicons  |
+
+* simple_form >= 3.3
+
+Installation
+------------
+
+    gem 'wobapphelpers', github: 'swobspace/wobapphelpers', branch: "2-0-stable"
+    gem 'wobapphelpers', github: 'swobspace/wobapphelpers', branch: "1-0-stable"
+    gem 'wobapphelpers', github: 'swobspace/wobapphelpers', branch: "master"
+
+Generators
+----------
+
+wobapphelpers comes with some generators to install templates and so on:
+
+  * rails g wobapphelpers:install : installs some locales 
+  * rails g wobapphelpers:scaffold_templates : installs scaffold erb and templates 
+and a controller template using simple_form and bootstrap, responders and the 
+famous respond_with method.
+
+Usage
+-----
+
+### Helpers
+
+Helpers to ease use of glyphicon icons, predefined action links (i.e. edit_link),
+show_flash, and more ...
+
+    # myapp/app/helpers/application_helper.rb:
+    module ApplicationHelper
+      include Wobapphelpers::Helpers::All
+      ...
+      #or use specific modules
+      include Wobapphelpers::Helpers::IconHelper
+      include Wobapphelpers::Helpers::ActionViewHelper
+      ...
+    end
+
+### Responders
+
+Predefined settings for FlashResponder in gem 'responders' 
+(https://github.com/plataformatec/responders) including german locales.
+
+    # myapp/app/controllers/application_controller.rb
+    class ApplicationController < ActionController::Base
+      self.responder = Wobapphelpers::Responders
+      ...
+    end
+
+### Breadcrumbs
+
+Build breadcrumbs in the sense of backtrace, not of deepness. An example for 
+classical breadcrumbs is 
+
+    Home >> Posts >> posts#show
+
+Wobapphelpers::Breadcrumbs store a the last 6 urls like this:
+
+    Home >> Posts >> Post(1) >> Others >> Posts
+
+A breadcrumb will only be 
+added if the url differs from the last breadcrumb on the stack. 
+Wobapphelper::Breadcrumbs should be use in normal display actions like index 
+or show, but not in actions which are redirecting to others (not in :create,
+:update) and best not to use in form actions like :edit and :new. The latter 
+is a question of user experience, not a technical question. The back_link 
+from Wobapphelpers::Helpers::ActionViewHelper uses breadcrumbs, if available,
+so it would be better to build your own back link if you set breadcrumbs for
+:new and :edit.
+
+#### Breadcrumbs for #index
+
+Setting breadcrumbs for index can be done in ApplicationController:
+
+    # myapp/app/controllers/application_controller.rb
+    class ApplicationController < ActionController::Base
+      include Wobapphelpers::Breadcrumbs
+      before_filter :add_breadcrumb_index, only: [:index]
+      ...
+    end
+
+#### Breadcrumbs for #show
+
+Breadcrumbs for @post must be set after retrieving the object from database.
+Pay attention to the correct order of before_actions:
+
+    # myapp/app/controllers/posts_controller.rb
+    class PostsController < ApplicationController
+      before_action :set_post, only: [:show, :edit, :update, :destroy]
+      before_action :add_breadcrumb_show, only: [:show]
+      ....
+    
+      private
+    
+      def set set_post
+       @post = Post.find(params[:id])
+      end
+    end
+
+#### Generic Functions
+
+    # add a breadcrumb manually
+    add_breadcrumb(name, url)
+
+    # get the last breadcrumb from stack
+    last_breadcrumb_url
+
+#### Styling breadcrumbs
+
+Use builtin styling:
+
+    /* application.css
+    *= require wobapphelpers/breadcrumbs
+    /* ...
+
+or build your own stuff. :render_breadcrumbs gives you 
+a div#breadcrumbs tag.
+
+
+For :add_breadcrumb_show the variable must be named after your Model. For 
+other variable names you have to use :add_breadcrumbs_for, i.e.
+
+    # myapp/app/controllers/posts_controller.rb
+    class PostsController < ApplicationController
+      ...
+      def show
+        @other = Post.find(params[:id])
+        add_breadcrumbs_for(@other)
+      end
+      ...
+    end
+
+
+Licence
+-------
+
+Wobapphelpers Copyright (C) 2014-2018  Wolfgang Barth
+
+MIT License, see [LICENSE](LICENSE)
+

data/Rakefile

@@ -0,0 +1,30 @@
+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    = 'Wobapphelpers'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+  t.warning = false
+end
+
+
+task default: :test

data/app/assets/stylesheets/wobapphelpers/breadcrumbs.scss

@@ -0,0 +1,13 @@
+
+// --- breadcrumbs 
+#breadcrumbs {
+  color: #999;
+  padding: .5em 0 .5em 0;
+  a {
+    color: #999;
+    text-decoration: none;
+    &:hover { color: #111; }
+    &:hover { color: #111; }
+  }
+}
+

data/config/locales/de.yml

@@ -0,0 +1,9 @@
+de:
+  wobapphelpers:
+    helpers:
+      back: "Zurück"
+      cancel: "Abbrechen"
+    controller:
+      new:  "%{name} erstellen"
+      edit:  "%{name} bearbeiten"
+      update:  "%{name} bearbeiten"

data/config/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  wobapphelpers:
+    helpers:
+      back: Back
+      cancel: Cancel
+    controller:
+      new:  "create %{name}"
+      edit:  "update %{name}"
+      update:  "update %{name}"

data/lib/generators/templates/erb/scaffold/_form.html.erb

@@ -0,0 +1,26 @@
+<%%= simple_form_for(@<%= singular_table_name %>,
+  html: { class: 'form-horizontal well' },
+  wrapper: :horizontal_form,
+  wrapper_mappings: {
+    check_boxes: :horizontal_radio_and_checkboxes,
+    radio_buttons: :horizontal_radio_and_checkboxes,
+    file: :horizontal_file_input,
+    boolean: :horizontal_boolean
+  }) do |f| %>
+
+  <fieldset>
+    <%%= form_legend %>
+
+    <div class="form-inputs">
+    <%- attributes.each do |attribute| -%>
+      <%%= f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %><% (attribute.field_type == :date_select) ? ', as: :string' : '' %>
+       %>
+    <%- end -%>
+    </div>
+
+    <div class="col-sm-9 col-sm-offset-3">
+      <%%= f.button :submit, class: 'btn btn-primary' %>
+      <%%= cancel_button %>
+    </div>
+  </fieldset>
+<%% end %>

data/lib/generators/templates/erb/scaffold/edit.html.erb

@@ -0,0 +1 @@
+<%%= render 'form' %>

data/lib/generators/templates/erb/scaffold/index.html.erb

@@ -0,0 +1,32 @@
+<h1><%%= t('controller.<%= plural_table_name %>') %></h1>
+
+<table id="dataTable" class="table table-bordered table-striped dataTable">
+<thead>
+  <tr>
+<% attributes.each do |attribute| -%>
+    <th><%%= t('attributes.<%= attribute.name %>') %></th>
+<% end -%>
+    <th></th>
+  </tr>
+</thead>
+<tbody>
+
+<%% @<%= plural_table_name %>.each do |<%= singular_table_name %>| %>
+  <%%= content_tag_for(:tr, <%= singular_table_name %>) do %>
+<% attributes.each do |attribute| -%>
+    <td><%%= <%= singular_table_name %>.<%= attribute.name %> %></td>
+<% end -%>
+    <td class="nowrap">
+      <%%= show_link <%= singular_table_name %> %>
+      <%%= edit_link <%= singular_table_name %> %>
+      <%%= delete_link <%= singular_table_name %> %>
+    </td>
+  <%% end %>
+<%% end %>
+</tbody>
+</table>
+
+<br />
+
+<%%= back_link %>
+<%%= new_link <%= class_name %> %>

data/lib/generators/templates/erb/scaffold/new.html.erb

@@ -0,0 +1 @@
+<%%= render 'form' %>

data/lib/generators/templates/erb/scaffold/show.html.erb

@@ -0,0 +1,15 @@
+<table class="table table-bordered table-hover autowidth">
+<% attributes.each do |attribute| %>
+  <tr>
+    <th><%%= t('attributes.<%= attribute.name %>')%>:</th>
+    <td><%%= @<%= singular_table_name %>.<%= attribute.name %> %></td>
+  </tr>
+<% end -%>
+</table>
+
+<div role="toolbar">
+  <%%= back_link %>
+  <%%= edit_link(@<%= singular_table_name %>) %>
+  <%%= delete_link(@<%= singular_table_name %>) %>
+  <%%= new_link <%= class_name %> %>
+</div>

data/lib/generators/templates/initializers/wobapphelpers.rb

@@ -0,0 +1,18 @@
+Wobapphelpers.setup do |config|
+  #
+  # exclude some controllers from breadcrumbs
+  # the given string must match controller.controller_name
+  #
+  # example:
+  # config.breadcrumb_controller_blacklist = ["user_sessions"]
+  # default:
+  # config.breadcrumb_controller_blacklist = []
+  #
+  # show action links only if has ability to execute the action
+  # * :none : always present action links
+  # * :cancan1 : for cancancan '~>1.7.0' or cancan '~>1.6.0'
+  # * :cancan2 : for cancan '~>2.0.0', untested
+  #
+  # default:
+  # config.cancan = :none
+end

data/lib/generators/templates/layouts/application.html.erb

@@ -0,0 +1,44 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>Dummy App</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<div class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+      <div class="container">
+        <div class="navbar-header">
+          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+            <span class="sr-only">Toggle navigation</span>
+            <span class="icon-bar"></span>
+            <span class="icon-bar"></span>
+            <span class="icon-bar"></span>
+          </button>
+          <a class="navbar-brand" href="<%= root_path if defined?(root_path)%>#">Dummy</a>
+        </div>
+        <div class="collapse navbar-collapse">
+          <ul class="nav navbar-nav">
+            <li class="active"><a href="/home">Home</a></li>
+          </ul>
+        </div><!--/.nav-collapse -->
+      </div>
+    </div>
+<div class="container">
+  <div class="alert alert-warning">
+    <p>Your application layout is unmodified. Please edit me!
+       Visit me in app/views/layouts/application.html.erb.</p>
+  </div>
+   <% unless controller.action_name =~ /(new|edit)/ %>
+     <%= render_breadcrumbs %>
+   <% end %>
+  <%= show_flash %>
+  <%= yield %>
+</div>
+
+</body>
+</html>

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

@@ -0,0 +1,66 @@
+<% 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: [:show, :edit, :update, :destroy]
+  before_action :add_breadcrumb_show, only: [:show]
+
+  # GET <%= route_url %>
+  def index
+    @<%= plural_table_name %> = <%= orm_class.all(class_name) %>
+    respond_with(@<%= plural_table_name %>)
+  end
+
+  # GET <%= route_url %>/1
+  def show
+    respond_with(@<%= singular_table_name %>)
+  end
+
+  # GET <%= route_url %>/new
+  def new
+    @<%= singular_table_name %> = <%= orm_class.build(class_name) %>
+    respond_with(@<%= singular_table_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") %>
+
+    @<%= orm_instance.save %>
+    respond_with(@<%= singular_table_name %>)
+  end
+
+  # PATCH/PUT <%= route_url %>/1
+  def update
+    @<%= orm_instance.update("#{singular_table_name}_params") %>
+    respond_with(@<%= singular_table_name %>)
+  end
+
+  # DELETE <%= route_url %>/1
+  def destroy
+    @<%= orm_instance.destroy %>
+    respond_with(@<%= singular_table_name %>)
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_<%= singular_table_name %>
+      @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    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 -%>