hashbrowns 0.1.3

data/hashbrowns.gemspec

@@ -0,0 +1,185 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "hashbrowns"
+  s.version = "0.1.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["crimsonknave"]
+  s.date = "2012-11-13"
+  s.description = "Provides a DSL and helpers to convert hashes into html tables.  Allows you to create overviews with selected fields, define keys whose values link to a url and so on."
+  s.email = "crimsonknave@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md",
+    "TODO"
+  ]
+  s.files = [
+    ".document",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "TODO",
+    "VERSION",
+    "example/.gitignore",
+    "example/.rvmrc",
+    "example/Gemfile",
+    "example/Gemfile.lock",
+    "example/README.rdoc",
+    "example/Rakefile",
+    "example/app/assets/images/rails.png",
+    "example/app/assets/javascripts/application.js",
+    "example/app/assets/javascripts/customers.js.coffee",
+    "example/app/assets/javascripts/destinations.js.coffee",
+    "example/app/assets/javascripts/orders.js.coffee",
+    "example/app/assets/stylesheets/application.css.scss",
+    "example/app/assets/stylesheets/bootstrap_and_overrides.css.scss",
+    "example/app/assets/stylesheets/customers.css.scss",
+    "example/app/assets/stylesheets/destinations.css.scss",
+    "example/app/assets/stylesheets/orders.css.scss",
+    "example/app/assets/stylesheets/scaffolds.css.scss",
+    "example/app/controllers/application_controller.rb",
+    "example/app/controllers/customers_controller.rb",
+    "example/app/controllers/destinations_controller.rb",
+    "example/app/controllers/orders_controller.rb",
+    "example/app/helpers/application_helper.rb",
+    "example/app/helpers/customers_helper.rb",
+    "example/app/helpers/destinations_helper.rb",
+    "example/app/helpers/orders_helper.rb",
+    "example/app/mailers/.gitkeep",
+    "example/app/models/.gitkeep",
+    "example/app/models/customer.rb",
+    "example/app/models/destination.rb",
+    "example/app/models/order.rb",
+    "example/app/views/customers/_form.html.erb",
+    "example/app/views/customers/edit.html.erb",
+    "example/app/views/customers/full.rabl",
+    "example/app/views/customers/index.html.erb",
+    "example/app/views/customers/index.rabl",
+    "example/app/views/customers/new.html.erb",
+    "example/app/views/customers/show.html.erb",
+    "example/app/views/customers/show.rabl",
+    "example/app/views/destinations/_form.html.erb",
+    "example/app/views/destinations/edit.html.erb",
+    "example/app/views/destinations/full.rabl",
+    "example/app/views/destinations/index.html.erb",
+    "example/app/views/destinations/index.rabl",
+    "example/app/views/destinations/new.html.erb",
+    "example/app/views/destinations/show.html.erb",
+    "example/app/views/destinations/show.rabl",
+    "example/app/views/layouts/application.html.erb",
+    "example/app/views/orders/_form.html.erb",
+    "example/app/views/orders/edit.html.erb",
+    "example/app/views/orders/full.rabl",
+    "example/app/views/orders/index.html.erb",
+    "example/app/views/orders/index.rabl",
+    "example/app/views/orders/new.html.erb",
+    "example/app/views/orders/show.html.erb",
+    "example/app/views/orders/show.rabl",
+    "example/config.ru",
+    "example/config/application.rb",
+    "example/config/boot.rb",
+    "example/config/database.yml",
+    "example/config/environment.rb",
+    "example/config/environments/development.rb",
+    "example/config/environments/production.rb",
+    "example/config/environments/test.rb",
+    "example/config/initializers/backtrace_silencers.rb",
+    "example/config/initializers/hashbrowns.rb",
+    "example/config/initializers/inflections.rb",
+    "example/config/initializers/mime_types.rb",
+    "example/config/initializers/secret_token.rb",
+    "example/config/initializers/session_store.rb",
+    "example/config/initializers/wrap_parameters.rb",
+    "example/config/locales/en.yml",
+    "example/config/routes.rb",
+    "example/db/migrate/20121102164922_create_customers.rb",
+    "example/db/migrate/20121102165116_create_orders.rb",
+    "example/db/migrate/20121102165208_create_destinations.rb",
+    "example/db/schema.rb",
+    "example/db/seeds.rb",
+    "example/lib/assets/.gitkeep",
+    "example/lib/tasks/.gitkeep",
+    "example/log/.gitkeep",
+    "example/public/404.html",
+    "example/public/422.html",
+    "example/public/500.html",
+    "example/public/favicon.ico",
+    "example/public/index.html",
+    "example/public/robots.txt",
+    "example/script/rails",
+    "example/test/fixtures/.gitkeep",
+    "example/test/fixtures/customers.yml",
+    "example/test/fixtures/destinations.yml",
+    "example/test/fixtures/orders.yml",
+    "example/test/functional/.gitkeep",
+    "example/test/functional/customers_controller_test.rb",
+    "example/test/functional/destinations_controller_test.rb",
+    "example/test/functional/orders_controller_test.rb",
+    "example/test/integration/.gitkeep",
+    "example/test/performance/browsing_test.rb",
+    "example/test/test_helper.rb",
+    "example/test/unit/.gitkeep",
+    "example/test/unit/customer_test.rb",
+    "example/test/unit/destination_test.rb",
+    "example/test/unit/helpers/customers_helper_test.rb",
+    "example/test/unit/helpers/destinations_helper_test.rb",
+    "example/test/unit/helpers/orders_helper_test.rb",
+    "example/test/unit/order_test.rb",
+    "example/vendor/assets/javascripts/.gitkeep",
+    "example/vendor/assets/stylesheets/.gitkeep",
+    "example/vendor/plugins/.gitkeep",
+    "hashbrowns.gemspec",
+    "lib/hashbrowns.rb",
+    "lib/hashbrowns/configuration.rb",
+    "lib/hashbrowns/helpers/display_helpers.rb",
+    "lib/hashbrowns/helpers/links_helpers.rb",
+    "lib/hashbrowns/helpers/overview_helpers.rb",
+    "lib/hashbrowns/helpers/relations_helpers.rb",
+    "lib/hashbrowns/helpers/renderer_helpers.rb",
+    "lib/hashbrowns/railtie.rb",
+    "lib/hashbrowns/views/hashbrowns/_overview.html.haml",
+    "lib/hashbrowns/views/hashbrowns/_recursive_hash_tabler.html.haml",
+    "test/helper.rb",
+    "test/test_hash_tabler.rb"
+  ]
+  s.homepage = "http://github.com/crimsonknave/hashbrowns"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.11"
+  s.summary = "Cooks your hashes into html"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<haml-rails>, [">= 0"])
+      s.add_runtime_dependency(%q<rake>, ["= 0.8.7"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<haml-rails>, [">= 0"])
+      s.add_dependency(%q<rake>, ["= 0.8.7"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<haml-rails>, [">= 0"])
+    s.add_dependency(%q<rake>, ["= 0.8.7"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/lib/hashbrowns/configuration.rb

@@ -0,0 +1,129 @@
+module HashBrowns
+  class Configuration
+    attr_accessor :link_hash, :link_for_id, :links, :link_parents, :key_fields, :parent_overrides, :status_hash, :table_styles, :key_fields, :pretty_names, :important, :ignore_important_case
+
+    VALID_STATUSES = %w(success info warning error)
+
+    def initialize
+      @link_hash = Hash.new
+      @link_for_id = Hash.new
+      @links = Set.new
+      @link_parents = Hash.new
+      @pretty_names = Hash.new
+      @important = Hash.new
+      @ignore_important_case = false
+
+      @status_hash = {
+        "green" => "success",
+        "blue" => "info",
+        "red" => "error",
+        "yellow" => "warning"
+      }
+
+      @table_styles = Set.new
+      @key_fields = Hash.new
+      @parent_overrides = Set.new
+
+    end
+
+    def add_status_mapping(name, status)
+      raise "Unknown Status" unless VALID_STATUSES.include?(status)
+      @status_hash[name] = status
+    end
+
+    def add_table_style(style)
+      @table_styles.add(style)
+    end
+    def add_table_styles(*styles)
+      @table_styles.merge(styles)
+    end
+
+    def add_parent_overrides(*parents)
+      @parent_overrides.merge(parents)
+    end
+
+    def add_parent_override(parent)
+      @parent_overrides.add(parent)
+    end
+
+    def add_overview_field(type, value, *path)
+      type, value, path = type.to_s, value.to_s, path.map{|p| p.to_s}
+      @key_fields[type] = Hash.new unless @key_fields.has_key?(type)
+      insert_value(@key_fields[type], value, path)
+    end
+
+    def add_important_name(name, value, status)
+      name, value, status = name.to_s, value.to_s, status.to_s
+      value = value.downcase if @ignore_important_case && value.kind_of?(String)
+      status = @status_hash[status] if @status_hash.has_key?(status)
+      if value.kind_of?(Proc)
+        @important[name] = value 
+        return
+      end
+
+      @important[name] = Hash.new unless @important.has_key?(name)
+      @important[name][value] = status
+    end
+
+    def add_formatted_name(real, formatted, source)
+      real, formatted, source = real.to_s, formatted.to_s, source.to_s
+      @pretty_names[real] = Hash.new unless @pretty_names.has_key?(real)
+      @pretty_names[real][source] = formatted
+    end
+
+    def add_external_links(*names)
+      @links.merge names.map{|x| x.to_s}
+    end
+
+    def add_external_link(name)
+      @links.add name.to_s
+    end
+
+    def add_link_for_id(key, parent)
+      key = key.to_s
+      @link_for_id[key] = Set.new if @link_for_id[key].nil?
+      @link_for_id[key].add(parent.to_s)
+    end
+
+    def add_links_for_id(key, parents)
+      key = key.to_s
+      @link_for_id[key] = Set.new if @link_for_id[key].nil?
+      @link_for_id[key].merge(parents.map(&:to_s))
+    end
+
+    def add_link_by_key(key, path)
+      @link_hash[key.to_s] = path.to_s
+    end
+
+    def add_link_by_parent(parent, key, path)
+      if @link_parents.has_key?(parent.to_s)
+        @link_parents[parent.to_s][key.to_s] = path.to_s
+      else
+        @link_parents[parent.to_s] = { key.to_s => path.to_s }
+      end
+    end
+
+    def add_link_by_parents(parents, key, path)
+      parents.each do |parent|
+        if @link_parents.has_key?(parent.to_s)
+          @link_parents[parent.to_s][key.to_s] = path.to_s
+        else
+          @link_parents[parent.to_s] = { key.to_s => path.to_s }
+        end
+      end
+    end
+
+    private
+    def insert_value(hash, value, path)
+      current = path.shift
+      if current.nil?
+        hash[:values] = Set.new unless hash.has_key?(:values)
+        hash[:values].add(value)
+        return true
+      end
+      hash[current] = Hash.new unless hash.has_key?(current)
+      return insert_value(hash[current], value, path)
+    end
+
+  end
+end

data/lib/hashbrowns/helpers/display_helpers.rb

@@ -0,0 +1,27 @@
+module HashBrowns
+  module DisplayHelpers
+
+    def table_styles
+      return HashBrowns.conf.table_styles.to_a.join(" ")
+    end
+
+    def importantize(key, value)
+      value = value.downcase if HashBrowns.conf.ignore_important_case && value.kind_of?(String)
+      #puts "k: #{key}, v: #{value}"
+      return "nil key" if key.nil?
+      return "nil value" if value.nil?
+      return "#{key} not important" unless HashBrowns.conf.important.has_key?(key)
+      return "#{HashBrowns.conf.important[key].call(value)}" if HashBrowns.conf.important[key].kind_of?(Proc)
+      return "#{value} not important for #{key}" unless HashBrowns.conf.important[key].has_key?(value)
+      return "#{HashBrowns.conf.important[key][value]}"
+    end
+
+    def display_name(name, table)
+      names = HashBrowns.conf.pretty_names[name]
+      return name unless names
+      return names[table] ? names[table] : name
+      return names["all"] if names.has_key?("all")
+    end
+
+  end
+end

data/lib/hashbrowns/helpers/links_helpers.rb

@@ -0,0 +1,24 @@
+module HashBrowns
+  module LinksHelpers
+    def linkify(key, value, parent = false, id = false, text = false)
+      return "" if value.nil? or key.nil?
+      key, value, parent, id, text = key.to_s, value.to_s, parent.to_s, id.to_s, text.to_s
+      text = value if text
+      puts "k #{key}, v #{value}, p #{parent} i #{id} t #{text}"
+      return link_to(text, HashBrowns.conf.link_parents[parent][key]+value).html_safe if parent && HashBrowns.conf.link_parents.has_key?(parent) && HashBrowns.conf.link_parents[parent].has_key?(key)
+      return link_to(text, HashBrowns.conf.link_hash[key]+value).html_safe if HashBrowns.conf.link_hash.has_key?(key)
+      return link_to(text, value).html_safe if HashBrowns.conf.links.include?(key)
+      return link_to(text, HashBrowns.conf.link_parents[parent]["id"]+id).html_safe if id && parent && HashBrowns.conf.link_for_id.has_key?(key) && HashBrowns.conf.link_for_id[key].include?(parent)
+      return value
+    end
+
+    def get_value_and_id(object, path)
+      #puts "o #{object.inspect} p #{p.inspect}"
+      value = object[path.shift.to_s]
+      value = "false" if value.nil?
+      #puts "value is '#{value}'"
+      return value.to_s, object["id"] if path.empty? or value.nil?
+      return get_value_and_id(value, path)
+    end
+  end
+end

data/lib/hashbrowns/helpers/overview_helpers.rb

@@ -0,0 +1,20 @@
+module HashBrowns
+  module OverviewHelpers
+
+    def overview_fields(type)
+      type = type.to_s
+      fields = HashBrowns.conf.key_fields[type]
+      return [] unless fields
+      puts "calling field parser now"
+      return field_parser(type, fields, [])
+    end
+
+    def field_parser(k, v, path)
+      k, path = k.to_s, path.map{|p| p.to_s}
+      return "#{k} had nil value at #{path.inspect}" if v.nil?
+      return v.map{|i| [display_name(i, path.last), path + [i]] } if k == "values"
+      return v.map{|ki, vi| field_parser(ki, vi, path + [k]) }.inject(:+)
+    end
+
+  end
+end

data/lib/hashbrowns/helpers/relations_helpers.rb

@@ -0,0 +1,9 @@
+module HashBrowns
+  module RelationsHelpers
+
+    def parent_setter(child, parent)
+      return parent if HashBrowns.conf.parent_overrides.include?(parent)
+      return child
+    end
+  end
+end

data/lib/hashbrowns/helpers/renderer_helpers.rb

@@ -0,0 +1,12 @@
+module HashBrowns
+  module RendererHelpers
+    def render_hash_to_overview(type, object)
+      #We don't pass in overview_fields here once because we shift the path and that messes up the case the overview is an array
+      render :partial => "hashbrowns/overview", :locals => { :object => object, :type => type }
+    end
+
+    def render_hash_to_table(object, parent = "")
+      render :partial => "hashbrowns/recursive_hash_tabler", :locals => {:object => object, :parent => parent}
+    end
+  end
+end

data/lib/hashbrowns/railtie.rb

@@ -0,0 +1,17 @@
+require 'hashbrowns/helpers/display_helpers'
+require 'hashbrowns/helpers/overview_helpers'
+require 'hashbrowns/helpers/links_helpers'
+require 'hashbrowns/helpers/relations_helpers'
+require 'hashbrowns/helpers/renderer_helpers'
+module HashBrowns
+  class Railtie < Rails::Engine
+    initializer "hashbrowns.view_helpers" do
+      ActionView::Base.send :include, DisplayHelpers
+      ActionView::Base.send :include, OverviewHelpers
+      ActionView::Base.send :include, LinksHelpers
+      ActionView::Base.send :include, RelationsHelpers
+      ActionView::Base.send :include, RendererHelpers
+    end
+    paths["app/views"] = "lib/hashbrowns/views"
+  end
+end

data/lib/hashbrowns/views/hashbrowns/_overview.html.haml

@@ -0,0 +1,20 @@
+%table{:class => table_styles}
+  - if object.kind_of?(Array)
+    %tr
+      - overview_fields(type).each do |k, path|
+        %th= k.to_s.humanize
+    - object.each do |o|
+      %tr
+        - overview_fields(type).each do |k, path|
+          - parent = path.empty? ? type : path[-2]
+          - path.shift
+          - value, id = get_value_and_id(o, path)
+          %td{:class => importantize(k, value)}= linkify(k, value, parent, id)
+  - else
+    - overview_fields(type).each do |k, path|
+      - parent = path.empty? ? type : path[-2]
+      - path.shift
+      - value, id = get_value_and_id(object, path)
+      %tr{ :class => importantize(k, value)}
+        %td= k.to_s.humanize
+        %td= linkify(k, value, parent, id)

data/lib/hashbrowns/views/hashbrowns/_recursive_hash_tabler.html.haml

@@ -0,0 +1,27 @@
+- if object.kind_of?(Array)
+  - object.each do |i|
+    = render :partial => "hashbrowns/recursive_hash_tabler", :locals => { :object => i, :parent => parent }
+- elsif
+  %table{:class => table_styles}
+    - object.each_pair do |k,v|
+      - if v.kind_of?(Hash)
+        %tr
+          %td= k
+          %td= render :partial => "hashbrowns/recursive_hash_tabler", :locals => { :object => v, :parent => parent_setter(k,parent) } unless v.blank?
+      - elsif v.kind_of?(Array)
+        %tr
+          %td= k
+          %td
+            - v.each do |i|
+              - if i.kind_of?(Hash)
+                = render :partial => "hashbrowns/recursive_hash_tabler", :locals => { :object => i, :parent => parent_setter(k, parent) } unless i.blank?
+      - else
+        %tr{ :class => importantize(k, v) }
+          %td= k
+          %td
+            - if defined?(parent)
+              = linkify(k,v,parent)
+            - else
+              = linkify(k,v)
+- else
+  = object

data/lib/hashbrowns.rb

@@ -0,0 +1,16 @@
+require 'hashbrowns/railtie' if defined?(Rails)
+require 'haml'
+require 'hashbrowns/configuration'
+
+module HashBrowns
+  class << self
+    def configure(&block)
+      yield(conf)
+      conf
+    end
+
+    def conf
+      @_configuration ||= Configuration.new
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'hashbrowns'
+
+class Test::Unit::TestCase
+end

data/test/test_hash_tabler.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestHashTabler < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end