buttons_for 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b6c11cb799b2692dd13249fc016f00069856bf9
+  data.tar.gz: 0144cd29a93f7eeff8704a6639838bba112eb881
+SHA512:
+  metadata.gz: dc98e51c447eec371b31e6c5dc6bb08e72de9408eb5b32f4da2c333600cb7b24f0f685e5fe43d1c21ee5161e540a9f77efff4d1b76c1ac87c394447525702c7a
+  data.tar.gz: a9c26d13f023aab59bb1c84bc48cab80c0c7c051988bd325ea7b7113b57304f77423c79f73fe2ea04da50b42ea321ef3a13d87658615533347d81ee763549031

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Ole J. Rosendahl
+
+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/Rakefile

@@ -0,0 +1,34 @@
+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    = 'ButtonsFor'
+  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
+end
+
+
+task default: :test

data/app/helpers/buttons_for/rails/buttons_for_helper.rb

@@ -0,0 +1,128 @@
+module ButtonsFor
+  module Rails
+    module ButtonsForHelper
+
+      def buttons_for(options = {}, &block)
+        raise ArgumentError, "Missing block" unless block_given?
+
+        capture ButtonsForBuilder.new(self), &block
+      end
+
+      class ButtonsForBuilder
+        include ActionView::Helpers
+        include FontAwesome::Rails::IconHelper
+
+        attr_accessor :template, :output_buffer
+
+        def initialize(template)
+          @template = template
+        end
+
+        def button(text, url, options = {}, &block)
+          icon_options = extract_icon_options!(options)
+
+          link_to label(text, icon_options), url, options.merge(
+            class: classes(options),
+            title: t(text),
+          )
+        end
+
+        def new(url, options = {})
+          options[:label] ||= label(:new)
+
+          button options[:label], url, options.reverse_merge(
+            icon: 'plus',
+            class: 'btn-success'
+          )
+        end
+
+        def edit(url, options = {})
+          options[:label] ||= label(:edit)
+
+          button options[:label], url, options.reverse_merge(
+            class: 'btn-default',
+            icon: 'pencil'
+          )
+        end
+
+        def export(url, options = {})
+          options[:label] ||= label(:export)
+
+          button options[:label], url, options.reverse_merge(
+            class: 'btn-default',
+            icon: 'file-text-o'
+          )
+        end
+
+        def delete(url, options = {})
+          options[:label] ||= label(:delete)
+
+          button options[:label], url, options.reverse_merge(
+            class: 'btn-danger',
+            icon: 'trash-o',
+            method: :delete,
+            data: {
+              confirm: t(:confirm)
+            }
+          )
+        end
+
+        def dropdown(text, options = {}, &block)
+          raise ArgumentError, "Missing block" unless block_given?
+
+          icon_options = extract_icon_options!(options)
+
+          content_tag(:div, class: "btn-group") do
+            concat(content_tag(:button, label(text), class: "btn btn-default dropdown-toggle", data: {toggle: "dropdown"}, aria: {haspopup: "true", expanded: "false"}) do
+              "#{label(text, icon_options)} #{content_tag(:span, '', class: "caret")}".html_safe
+            end)
+            concat(content_tag(:ul, class: "dropdown-menu", "aria-labelledby" => text) do
+              concat template.capture(&block)
+            end)
+          end
+        end
+
+        def link(text, path, options = {})
+          options[:title] ||= label(text)
+
+          icon_options = extract_icon_options!(options)
+
+          content_tag(:li, link_to(label(text, icon_options), path, options))
+        end
+
+        private
+
+        def extract_icon_options!(options)
+          {}.tap do |icon_options|
+            icon_options[:icon] = options.delete(:icon) if options.key?(:icon)
+          end
+        end
+
+        def t(string)
+          I18n.t("buttons_for.#{string.to_s}", default: string.to_s.titleize)
+        end
+
+        def label(text, options = {})
+          label = text.is_a?(String) ? text : t(text)
+
+          if options[:icon]
+            fa_icon(options[:icon], text: label)
+          else
+            label
+          end
+        end
+
+        def classes(options)
+          "btn".tap do |s|
+            s << " #{options[:class]}" if options[:class]
+          end
+        end
+
+        def protect_against_forgery?
+          false
+        end
+
+      end
+    end
+  end
+end

data/lib/buttons_for.rb

@@ -0,0 +1,3 @@
+require "buttons_for/version"
+require "buttons_for/engine"
+require "font-awesome-rails"

data/lib/buttons_for/engine.rb

@@ -0,0 +1,4 @@
+module ButtonsFor
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/buttons_for/version.rb

@@ -0,0 +1,3 @@
+module ButtonsFor
+  VERSION = "0.1.0"
+end

data/lib/generators/buttons_for/install_generator.rb

@@ -0,0 +1,14 @@
+module ButtonsFor
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      desc "Copy ButtonsFor translations"
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_translations
+        copy_file "buttons_for.en.yml", "config/locales/buttons_for.en.yml"
+      end
+
+    end
+  end
+end

data/lib/generators/buttons_for/templates/buttons_for.en.yml

@@ -0,0 +1,8 @@
+en:
+  buttons_for:
+    actions: "Actions"
+    new: "New"
+    edit: "Edit"
+    delete: "Delete"
+    export: "Export"
+    confirm: "Are you sure?"

data/lib/tasks/buttons_for_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :buttons_for do
+#   # Task goes here
+# end

data/test/buttons_for_helper_test.rb

@@ -0,0 +1,115 @@
+require "test_helper"
+
+class ButtonsFor::Rails::ButtonsForHelperTest < ActionView::TestCase
+
+  test "#buttons_for(&block)" do
+    assert_raises(ArgumentError) { buttons_for }
+  end
+
+  test "#button" do
+    with_concat_buttons_for { |b| b.button "New", "#" }
+    assert_select "a.btn[href=\"#\"][title=\"New\"]", text: "New"
+  end
+
+  test "#button capitalize text if translation is symbol" do
+    with_concat_buttons_for { |b| b.button :capitalized_text, "#" }
+    assert_select "a.btn", text: "Capitalized Text"
+  end
+
+  test "#button uses the text directly if text is a string" do
+    with_concat_buttons_for { |b| b.button "capitalized text", "#" }
+    assert_select "a.btn", text: "capitalized text"
+  end
+
+  test "#button uses the translation if value exists for key" do
+    store_translations(:en, buttons_for: {close: "Lukk"}) do
+      with_concat_buttons_for { |b| b.button :close, "#" }
+    end
+    assert_select "a.btn", text: "Lukk"
+  end
+
+  test "#new" do
+    with_concat_buttons_for { |b| b.new "#" }
+    assert_select "a.btn.btn-success[href=\"#\"][title=\"New\"]", text: "New" do |element|
+      assert_select element, "i.fa.fa-plus"
+    end
+  end
+
+  test "#edit" do
+    with_concat_buttons_for { |b| b.edit "#" }
+    assert_select "a.btn.btn-default[href=\"#\"][title=\"Edit\"]", text: "Edit" do |element|
+      assert_select element, "i.fa.fa-pencil"
+    end
+  end
+
+  test "#delete" do
+    with_concat_buttons_for { |b| b.delete "#" }
+    assert_select "a.btn.btn[href=\"#\"][title=\"Delete\"][data-confirm=\"Are you sure?\"]", text: "Delete" do |element|
+      assert_select element, "i.fa.fa-trash-o"
+    end
+  end
+
+  test "#export" do
+    with_concat_buttons_for { |b| b.export "#" }
+    assert_select "a.btn.btn[href=\"#\"][title=\"Export\"]", text: "Export" do |element|
+      assert_select element, "i.fa.fa-file-text-o"
+    end
+  end
+
+  test "options[:label]" do
+    with_concat_buttons_for { |b| b.new "#", label: "New Project" }
+    assert_select "a", text: "New Project"
+  end
+
+  test "#dropdown with content generates at dropdown" do
+    with_concat_buttons_for do |b|
+      b.dropdown(:actions) { "content" }
+    end
+    assert_select "div.btn-group" do |btn_element|
+      assert_select btn_element, "button.btn.btn-default.dropdown-toggle[data-toggle=\"dropdown\"][aria-haspopup=\"true\"][aria-expanded=\"false\"]", text: "Actions"
+      assert_select btn_element, "span.caret"
+      assert_select btn_element, "ul.dropdown-menu[aria-labelledby=\"actions\"]", text: "content"
+    end
+  end
+
+  test "#dropdown options[:icon] prepends icon to label" do
+    with_concat_buttons_for do |b|
+      b.dropdown("New", icon: "plus") { "content" }
+    end
+    assert_select "i.fa.fa-plus"
+  end
+
+  test "#dropdown raises error of block is missing" do
+    assert_raises(ArgumentError) do
+      with_concat_buttons_for { |b| b.dropdown(:actions) }
+    end
+  end
+
+  test "#link" do
+    with_concat_buttons_for  { |b| b.link "text", "#" }
+    assert_select "li a[href=\"#\"][title=\"text\"]", text: "text"
+  end
+
+  test "#link options[:icon]" do
+    with_concat_buttons_for do |b|
+      b.link "content", "#", icon: "shopping-cart"
+    end
+
+    assert_select "li a[href=\"#\"][title=\"content\"]"
+  end
+
+  private
+
+  def store_translations(locale, translations, &block)
+    I18n.backend.store_translations locale, translations
+    yield
+  ensure
+    I18n.reload!
+    I18n.backend.send :init_translations
+  end
+
+  def with_concat_buttons_for(*args, &block)
+    concat buttons_for(*args, &block)
+  end
+
+end

data/test/buttons_for_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ButtonsForTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, ButtonsFor
+  end
+end

data/test/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/test/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/test/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 any plugin's vendor/assets/javascripts directory 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/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/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 any plugin's vendor/assets/stylesheets directory 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/test/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/test/dummy/app/helpers/application_helper.rb

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

data/test/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>