bootstrap_builders 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc1068f1df81b83a1cbe318ab91a09f816a49703
-  data.tar.gz: 3122ddf8127d24598e017d73a79fe4f15e927ef0
+  metadata.gz: c2e43bdc56f44def9fdde24067ba74e9496dd833
+  data.tar.gz: fec8d583324e41c4728d2ceb50f36e9567fd0076
 SHA512:
-  metadata.gz: 43bece537feb0ddd22817f6880ba5eb5bc14806c95d572c5ef4fa8a3322904a1dff514861fffa406ad64daa69dea1285281d59d5a7d055e2656a2be6508265d6
-  data.tar.gz: 5b7564b32f6e7b15f8cd4fd2d751b2f44a7c370d48cd545b28e726360ae34931d46e45db67a246b661895917fced47a8a4898b8304155e9e10582c34ee4d0c06
+  metadata.gz: 0f19384fe95607c4d333ae2cf2fab73f4b2db0adf4a698b3bb1c7e792bc7130a8c3b8a1b69f27b474b90009d4df8954f7f5fe4ecf865d309e0ce0661c8b95eec
+  data.tar.gz: bc903302b6ca80d51f885dd512a8a08a738bc6c7e52aad5c217a544ce7d865b61a80ed95c36e58b535453c6a038f5ba3aaad8103eca77e77fae64ec09ac43203

data/{LICENSE.txt → MIT-LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2016 kaspernj
+Copyright 2016 kaspernj
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,4 +1,4 @@
-# bootstrap_builders
+# BootstrapBuilders
 
 ## Install
 
@@ -10,24 +10,69 @@ gem "bootstrap_builders"
 Then add to your `ApplicationHelper` module:
 ```ruby
 module ApplicationHelper
-  include BootstrapBuilders::Helpers
+  include BootstrapBuilders::ApplicationHelper
 end
 ```
 
 ## Usage
 
-### Box
+### Panel
+
+1. Panel in all its glory with elements and classes
+2. Controls if `:right` argument is given
+3. Table if `:table` argument is given
+
 ```haml
-= box "Title of box", right: button_content do
-  Content of box
+= bb_panel "Title of panel", right: button_content do
+  Content of panel
 ```
 
-### Box with a table
+### Panel with a table
+
 ```haml
-= box "Title of box", table: true do
+= bb_panel "Title of panel", table: true do
   %tbody
     %tr
       %td= "Test"
+```
+
+You can add custom classes like this:
+```haml
+= bb_panel "Title of panel", table: {bs_classes: [:striped]} do
+  %tbody
+    %tr
+      %td Test
+```
+
+### Table
+
+1. Adds Bootstrap classes: "table", "table-hover", "table-striped"
+
+```haml
+= bb_table do
+  %tbody
+    %tr
+      %td= "Test"
+```
+
+You can change the default classes like this:
+```ruby
+BootstrapBuilders.configuration.default_table_classes = [:striped, :hover]
+```
+
+The classes "bb-table" and "table" are always added.
+
+### Buttons
+
+1. Adds icons automatically
+2. Adds labels automatically
+3. Doesn't show button if CanCan doesn't allow it
+
+```haml
+= bb_new_btn url: [:admin, User]
+= bb_edit_btn url: [:admin, user], mini: true
+= bb_destroy_btn url: [:admin, user], label: false
+```
 
 ## Contributing to bootstrap_builders
 
@@ -43,4 +88,3 @@ end
 
 Copyright (c) 2016 kaspernj. See LICENSE.txt for
 further details.
-

data/Rakefile

@@ -1,53 +1,26 @@
-# encoding: utf-8
-
-require "rubygems"
-require "bundler"
 begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require "rake"
-
-require "jeweler"
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
-  gem.name = "bootstrap_builders"
-  gem.homepage = "http://github.com/kaspernj/bootstrap_builders"
-  gem.license = "MIT"
-  gem.summary = %(A library to generate Bootstrap HTML for Rails.)
-  gem.description = %(A library to generate Bootstrap HTML for Rails.)
-  gem.email = "k@spernj.org"
-  gem.authors = ["kaspernj"]
-  # dependencies defined in Gemfile
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
-Jeweler::RubygemsDotOrgTasks.new
-
-require "rspec/core"
-require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList["spec/**/*_spec.rb"]
-end
-
-desc "Code coverage detail"
-task :simplecov do
-  ENV["COVERAGE"] = "true"
-  Rake::Task["spec"].execute
-end
-
-task default: :spec
 
 require "rdoc/task"
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?("VERSION") ? File.read("VERSION") : ""
 
+RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = "rdoc"
-  rdoc.title = "bootstrap_builders #{version}"
-  rdoc.rdoc_files.include("README*")
+  rdoc.title    = "BootstrapBuilders"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.rdoc")
   rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-require "best_practice_project"
-BestPracticeProject.load_tasks
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+
+Bundler::GemHelper.install_tasks
+
+if Rails.env.development? || Rails.env.test?
+  require "best_practice_project"
+  BestPracticeProject.load_tasks
+end

data/app/assets/javascripts/bootstrap_builders/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/app/assets/stylesheets/bootstrap_builders/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/app/controllers/bootstrap_builders/application_controller.rb

@@ -0,0 +1,2 @@
+class BootstrapBuilders::ApplicationController < ActionController::Base
+end

data/app/helpers/bootstrap_builders/application_helper.rb

@@ -0,0 +1,104 @@
+module BootstrapBuilders::ApplicationHelper
+  def bb_attribute_rows(model, attributes)
+    BootstrapBuilders::AttributeRows.new(model: model, attributes: attributes, context: self).html
+  end
+
+  def bb_panel(*opts, &blk)
+    title = opts.shift unless opts.first.is_a?(Hash)
+    width = opts.shift unless opts.first.is_a?(Hash)
+
+    if opts.length == 1 && opts.first.is_a?(Hash)
+      args = opts.first
+      title = args.fetch(:title) if args.key?(:title)
+      width = args[:width] if args.key?(:width)
+      right = args[:right] if args.key?(:right)
+    else
+      args = {}
+    end
+
+    BootstrapBuilders::Panel.new(args.merge(title: title, width: width, right: right, block: blk, context: self)).html
+  end
+
+  def bb_btn(*args)
+    args = BootstrapBuilders::Button.parse_url_args(args)
+    args[:context] = self
+    button = BootstrapBuilders::Button.new(args)
+    button.classes.add("bb-btn")
+    button.html
+  end
+
+  def bb_edit_btn(*args)
+    args = BootstrapBuilders::Button.parse_url_args(args)
+    args[:label] = t("edit") unless args.key?(:label)
+    args[:title] ||= t("edit") if args[:mini]
+    args[:url] = [:edit, args.fetch(:url)] if args[:url] && !args[:url].is_a?(Array) && BootstrapBuilders::IsAChecker.is_a?(args[:url], "ActiveRecord::Base")
+
+    button = BootstrapBuilders::Button.new(args.merge(icon: "wrench", context: self, can_type: :edit))
+    button.classes.add(["bb-btn", "bb-btn-edit"])
+    button.classes.add("bb-btn-edit-#{button.can_model_class.name.tableize.singularize}") if button.can_model_class
+    button.classes.add("bb-btn-edit-#{button.can_model_class.name.tableize.singularize}-#{button.can_model.id}") if button.can_model
+    button.html
+  end
+
+  def bb_destroy_btn(*args)
+    args = BootstrapBuilders::Button.parse_url_args(args)
+    args[:label] = t("delete") unless args.key?(:label)
+    args[:title] ||= t("delete") if args[:mini]
+
+    args[:data] ||= {}
+    args[:data][:confirm] ||= t("are_you_sure")
+
+    button = BootstrapBuilders::Button.new(args.merge(icon: "remove", context: self, can_type: :destroy, method: :delete))
+    button.classes.add(["btn-danger", "bb-btn", "bb-btn-destroy"])
+    button.classes.add("bb-btn-destroy-#{button.can_model_class.name.tableize.singularize}") if button.can_model_class
+    button.classes.add("bb-btn-destroy-#{button.can_model_class.name.tableize.singularize}-#{button.can_model.id}") if button.can_model
+    button.html
+  end
+
+  def bb_new_btn(*args)
+    args = BootstrapBuilders::Button.parse_url_args(args)
+    args[:label] = t("add_new") unless args.key?(:label)
+    args[:title] ||= t("new") if args[:mini]
+
+    button = BootstrapBuilders::Button.new(args.merge(icon: "pencil", context: self, can_type: :new))
+    button.classes.add(["bb-btn", "bb-btn-new"])
+    button.classes.add("bb-btn-new-#{button.can_model_class.name.tableize.singularize}") if button.can_model_class
+    button.html
+  end
+
+  def bb_index_btn(*args)
+    args = BootstrapBuilders::Button.parse_url_args(args)
+    args[:title] ||= t("index") if args[:mini]
+
+    button = BootstrapBuilders::Button.new(args.merge(icon: "table", context: self, can_type: :index))
+
+    if button.label.to_s.strip.empty?
+      if button.can_model_class
+        button.label = button.can_model_class.model_name.human(count: 2)
+      else
+        button.label = t("index")
+      end
+    end
+
+    button.classes.add(["bb-btn", "bb-btn-index"])
+    button.classes.add("bb-btn-index-#{button.can_model_class.name.tableize}") if button.can_model_class
+    button.html
+  end
+
+  def bb_show_btn(*args)
+    args = BootstrapBuilders::Button.parse_url_args(args)
+    args[:label] = t("show") unless args.key?(:label)
+    args[:title] ||= t("show") if args[:mini]
+
+    button = BootstrapBuilders::Button.new(args.merge(icon: "square-o", context: self, can_type: :show))
+    button.classes.add(["bb-btn", "bb-btn-show"])
+    button.classes.add("bb-btn-show-#{button.can_model_class.name.tableize.singularize}") if button.can_model_class
+    button.classes.add("bb-btn-show-#{button.can_model_class.name.tableize.singularize}-#{button.can_model.id}") if button.can_model
+    button.html
+  end
+
+  def bb_table(args = {}, &blk)
+    table = BootstrapBuilders::Table.new(args.merge(context: self, blk: blk))
+    table.html
+  end
+end

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

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

data/config/routes.rb

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

data/config/spring.rb

@@ -0,0 +1 @@
+Spring.application_root = "./spec/dummy"

data/lib/bootstrap_builders.rb

@@ -1,9 +1,19 @@
+require "bootstrap_builders/engine"
+require "haml"
 require "html_gen"
 
-class BootstrapBuilders
-  path = "#{File.dirname(__FILE__)}/bootstrap_builders"
+module BootstrapBuilders
+  extend ActiveSupport::Autoload
 
-  autoload :ApplicationHelpers, "#{path}/application_helpers"
-  autoload :Box, "#{path}/box"
-  autoload :Button, "#{path}/button"
+  autoload :AttributeRows
+  autoload :Button
+  autoload :ClassAttributeHandler
+  autoload :Configuration
+  autoload :IsAChecker
+  autoload :Panel
+  autoload :Table
+
+  def self.configuration
+    @configuration ||= BootstrapBuilders::Configuration.new
+  end
 end

data/lib/bootstrap_builders/attribute_rows.rb

@@ -0,0 +1,95 @@
+class BootstrapBuilders::AttributeRows
+  def initialize(args)
+    @model = args.fetch(:model)
+    @attributes = args.fetch(:attributes)
+    @context = args.fetch(:context)
+  end
+
+  def html
+    elements = []
+
+    @attributes.each do |attribute|
+      tr = HtmlGen::Element.new(:tr, inden: "  ", classes: ["bb-attributes-row", "bb-attributes-row-#{attribute}"])
+      tr.add_ele(:th, classes: ["bb-attributes-row-title"], str: @model.class.human_attribute_name(attribute))
+
+      if column_type(attribute) == :boolean
+        str = @model.__send__("#{attribute}?") ? @context.t("yes") : @context.t("no")
+      elsif column_type(attribute) == :model
+        model_value = column_value(attribute)
+
+        unless model_value.nil?
+          link_method_name = "link_to_#{StringCases.camel_to_snake(model_value.class.name)}"
+
+          if @view.respond_to?(:link_to_model)
+            str = @view.link_to_model(model_value)
+          elsif @context.respond_to?(link_method_name)
+            str_html = @context.__send__(link_method_name, model_value)
+          else
+            str = model_value.name
+          end
+        end
+      elsif column_type(attribute) == :datetime || column_type(attribute) == :date
+        str = @context.l(column_value(attribute), format: :long) if column_value(attribute)
+      elsif column_type(attribute) == :money
+        str = @context.number_to_currency(column_value(attribute), unit: "")
+      else
+        str = column_value(attribute).to_s
+      end
+
+      if str
+        tr.add_ele(:td, classes: ["bb-attributes-row-value"], str: str)
+      else
+        tr.add_ele(:td, classes: ["bb-attributes-row-value"], str_html: str_html)
+      end
+
+      elements << tr.html
+    end
+
+    html = elements.join("\n")
+    html = html.html_safe if html.respond_to?(:html_safe)
+    html
+  end
+
+private
+
+  def column_type(column)
+    return :state if column == :state && @model.class.respond_to?(:state_machine)
+
+    type = @model.class.columns_hash[column.to_s].try(:type)
+    return type if type
+
+    reflection = @model.class.reflections[column]
+    return :model if reflection && reflection.is_a?(ActiveRecord::Reflection::AssociationReflection)
+
+    return :money if @model.class.respond_to?(:monetized_attributes) && @model.class.monetized_attributes.key?(column)
+
+    value = column_value(column)
+    return :model if value.is_a?(ActiveRecord::Base)
+
+    reflection_association = @model.class.reflect_on_association(column)
+    return :model if reflection_association
+
+    return :method if @model.respond_to?(column)
+
+    raise "Couldn't find out type for column '#{column}' on class '#{@model.class.name}'."
+  end
+
+  def column_value(column)
+    translated_column_method = "#{column}_translated"
+    translated_column_method_end = "translated_#{column}"
+    translated_option_helper_method = "#{@model.class.name.underscore}_translated_#{column}"
+    translated_state_method_name = "#{@model.class.name.underscore}_translated_state"
+
+    if column == :state && @model.class.respond_to?(:state_machine) && @view.respond_to?(translated_state_method_name)
+      return @view.__send__(translated_state_method_name, @model)
+    elsif @view.respond_to?(translated_option_helper_method)
+      return @view.__send__(translated_option_helper_method, @model)
+    elsif @model.respond_to?(translated_column_method)
+      return @model.__send__(translated_column_method)
+    elsif @model.respond_to?(translated_column_method_end)
+      return @model.__send__(translated_column_method_end)
+    end
+
+    @model.__send__(column)
+  end
+end