html_format 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96b6d5c97736a6abbd8dd1b3c59a7303ff964bac
+  data.tar.gz: 9f8c5ba7219600b146ea968068acf402b02b34aa
+SHA512:
+  metadata.gz: 90d3b4b912f638a8e4cd5e6b04ad0a0159bc9e93c5e778a1bed5f07c6aebaacf250a5d90ebcab3639bc2201ff27954b2877a2c01828743e9840eff1ed4ab7346
+  data.tar.gz: f2dd27105ce783a5ad91966c78d85ca030b58dc448f48f5b75243d769f7434dd4d8b440a98ece4f8cc2ab21d8ef7a97f72e6cc920ea66ac886a37ef1fb4ede39

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 akicho8
+
+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,33 @@
+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    = 'HtmlFormat'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+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/assets/stylesheets/html_format/control.sass

@@ -0,0 +1,18 @@
+.html_format
+  /* Horizontal scroll bar display
+  overflow-x: auto
+
+  /* No line break
+  white-space: nowrap
+
+  /* But the line inside the tool tip breaks
+  .tooltip
+    white-space: normal
+
+  /* When hash is displayed (type with key in the left column), right key the key
+  table.html_format_type_hash > tbody > tr > th
+    text-align: right
+
+  /* If th in the header is tight, gaps are increased so header can be changed to a new line
+  table.html_format_type_array_of_hash thead
+    white-space: normal

data/app/assets/stylesheets/html_format/default_theme.sass

@@ -0,0 +1,38 @@
+/* Please use it when not using bootstrap
+.html_format
+  overflow-x: auto
+  margin: 0px
+
+  &.html_format_depth_0
+    margin: 0.5em 0px
+
+  caption, .title
+    text-align: left
+    font-size: 80%
+
+  table
+    font-size: xx-small
+    margin: 0px
+    padding: 0px
+    background: #dddddd
+    border-collapse: separate
+    border-spacing: 2px
+
+    tr:nth-child(odd)
+      background: #eeeeee
+
+    tr:nth-child(even)
+      background: #ffffff
+
+    th, td
+      font-size: 10px
+      font-weight: bold
+      color: #555
+      padding: 3px
+      white-space: nowrap
+
+    a
+      color: inherit
+      text-decoration: none
+      &:hover
+        text-decoration: underline

data/lib/html_format.rb

@@ -0,0 +1,34 @@
+require "html_format/generator"
+require "html_format/core_ext"
+require "html_format/version"
+
+if defined?(Rails::Engine)
+  require 'html_format/engine'
+else
+  if defined?(ActiveSupport)
+    ActiveSupport.on_load(:active_record) do
+      include HtmlFormat::ActiveRecord
+
+      ActiveRecord::Result.class_eval do
+        def to_html(**options)
+          HtmlFormat.generate(collect(&:to_h), options)
+        end
+      end
+    end
+  end
+  if defined?(Mongoid::Document)
+    Mongoid::Document.include(HtmlFormat::ActiveRecord)
+  end
+end
+
+if defined?(Tapp)
+  module Tapp::Printer
+    class HtmlFormat < Base
+      def print(*args)
+        puts html_format(*args)
+      end
+    end
+
+    register :html_format, HtmlFormat
+  end
+end

data/lib/html_format/core_ext.rb

@@ -0,0 +1,35 @@
+require 'active_support/core_ext/kernel/concern'
+
+module HtmlFormat
+  concern :ActiveRecord do
+    class_methods do
+      def to_html(**options)
+        HtmlFormat.generate(all.collect(&:attributes), options)
+      end
+    end
+
+    def to_html(**options)
+      HtmlFormat.generate(attributes, options)
+    end
+  end
+end
+
+Kernel.class_eval do
+  private
+
+  def html_format(object, **options)
+    if object.respond_to?(:to_html)
+      object.to_html
+    else
+      HtmlFormat.generate(object, options)
+    end
+  end
+end
+
+[Array, Symbol, String, Hash, Numeric, TrueClass, FalseClass, NilClass].each do |e|
+  e.class_eval do
+    def to_html(**options)
+      HtmlFormat.generate(self, options)
+    end
+  end
+end

data/lib/html_format/engine.rb

@@ -0,0 +1,19 @@
+module HtmlFormat
+  class Engine < Rails::Engine
+    initializer 'html_format' do
+      ActiveSupport.on_load(:active_record) do
+        include HtmlFormat::ActiveRecord
+
+        ::ActiveRecord::Result.class_eval do
+          def to_html(**options)
+            HtmlFormat.generate(collect(&:to_h), options)
+          end
+        end
+      end
+
+      if defined?(Mongoid::Document)
+        Mongoid::Document.include(HtmlFormat::ActiveRecord)
+      end
+    end
+  end
+end

data/lib/html_format/generator.rb

@@ -0,0 +1,220 @@
+require 'active_support/core_ext/module'
+require 'active_support/core_ext/string'
+require 'action_view'
+
+module HtmlFormat
+  mattr_accessor :default_options
+  self.default_options = {
+    table_class: 'table table-striped table-bordered table-hover',
+    nesting: false,
+    title_tag: :h2,
+    header_patch: false,     # If there is no header, add it
+    key_label: 'Key',
+    value_label: 'Value',
+  }
+
+  def self.generate(*args, &block)
+    Generator.generate(*args, &block)
+  end
+
+  class Generator
+    include ActionView::Helpers::TagHelper
+
+    attr_accessor :output_buffer
+
+    def self.generate(*args, &block)
+      if block_given?
+        object = yield
+        options = args.extract_options!
+      else
+        if args.size == 0
+          return
+        elsif args.size == 1
+          object = args.first
+          options = {}
+        else
+          options = args.extract_options!
+          if args.size > 1
+            object = args
+          else
+            object = args.first
+          end
+        end
+      end
+
+      new(options).generate(object)
+    end
+
+    def initialize(options)
+      @options = HtmlFormat.default_options.merge(depth: 0).merge(options)
+    end
+
+    def generate(obj)
+      return if obj.blank?
+
+      info = function_table.find { |e| e[:_case].call(obj) }
+      body = ''.html_safe
+      if true
+        if @options[:caption].present?
+          body << content_tag(:caption, @options[:caption])
+        end
+      end
+      if @options[:header_patch]
+        if info[:header_patch]
+          if v = info[:header_patch].call(obj)
+            body << v
+          end
+        end
+      end
+      body << info[:process].call(obj)
+      body = content_tag(:table, body, :class => table_class(info))
+      if @options[:depth].zero?
+        if @options[:responsive]
+          body = content_tag(:div, body, :class => 'table-responsive')
+        end
+        if @options[:title].present?
+          body = content_tag(@options[:title_tag], @options[:title], :class => 'title') + body
+        end
+      end
+      content_tag(:div, body, :class => "html_format html_format_depth_#{@options[:depth]}")
+    end
+
+    private
+
+    def function_table
+      [
+        # {a: 1, b: 2}
+        # [a][1]
+        # [b][2]
+        {
+          _case: -> e { e.kind_of?(Hash) },
+          css_class: 'html_format_type_hash',
+          header_patch: -> e {
+            content_tag(:thead) do
+              tr do
+                th(@options[:key_label]) + th(@options[:value_label])
+              end
+            end
+          },
+          process: -> e {
+            e.collect {|key, val|
+              tr do
+                th(key) + td(val)
+              end
+            }.join.html_safe
+          },
+        },
+
+        # [{a: 1, b: 2}, {a: 3, b: 4}]
+        # [a][b]
+        # [1][2]
+        # [3][4]
+        {
+          _case: -> e { e.kind_of?(Array) && e.all?{|e|e.kind_of?(Hash)} },
+          css_class: 'html_format_type_array_of_hash',
+          process: -> e {
+            keys = e.inject([]) { |a, e| a | e.keys }
+            body = ''.html_safe
+            body += content_tag(:thead) do
+              tr do
+                keys.collect {|e| th(e) }.join.html_safe
+              end
+            end
+            body + content_tag(:tbody) do
+              e.collect { |hash|
+                tr do
+                  keys.collect { |key| td(hash[key]) }.join.html_safe
+                end
+              }.join.html_safe
+            end
+          },
+        },
+
+        # [[:a, :b], [ 1,  2], [ 3,  4]]
+        # [a][b]
+        # [1][2]
+        # [3][4]
+        {
+          _case: -> e { e.kind_of?(Array) && e.all?{|e|e.kind_of?(Array)} },
+          css_class: 'html_format_type_array_of_array',
+          header_patch: -> e {
+            if e.first.kind_of?(Array)
+              content_tag(:thead) do
+                e.first.collect { td('') }.join.html_safe # カラムの意味はわからないので空ラベルとする
+              end
+            end
+          },
+          process: -> e {
+            content_tag(:tbody) do
+              e.collect { |elems|
+                tr do
+                  elems.collect { |e| td(e) }.join.html_safe
+                end
+              }.join.html_safe
+            end
+          },
+        },
+
+        # [:a, :b]
+        # [a][b]
+        {
+          _case: -> e { e.kind_of?(Array) },
+          css_class: 'html_format_type_array',
+          process: -> e {
+            content_tag(:tbody) do
+              tr do
+                e.collect { |e| td(e) }.join.html_safe
+              end
+            end
+          },
+        },
+
+        # :a
+        # [a]
+        {
+          _case: -> e { true },
+          css_class: 'html_format_type_object',
+          process: -> e {
+            content_tag(:tbody) do
+              tr { td(e) }
+            end
+          },
+        },
+      ]
+    end
+
+    def tr(&block)
+      content_tag(:tr, &block)
+    end
+
+    def th(val)
+      content_tag(:th, val)
+    end
+
+    def td(val)
+      content_tag(:td, value_as_string(val))
+    end
+
+    def value_as_string(val)
+      if val.kind_of?(Array) || val.kind_of?(Hash)
+        if @options[:nesting]
+          self.class.generate(@options.merge(depth: @options[:depth].next)) { val }
+        else
+          val
+        end
+      else
+        val
+      end
+    end
+
+    def table_class(info)
+      if @options[:depth] == 0
+        # return 'table table-condensed table-bordered table-striped'
+        "table #{info[:css_class]} #{@options[:table_class]}".squish.scan(/\S+/).uniq.join(' ')
+      else
+        # 入れ子になったテーブルは小さめにして装飾を避ける
+        'table table-condensed'
+      end
+    end
+  end
+end

data/lib/html_format/version.rb

@@ -0,0 +1,3 @@
+module HtmlFormat
+  VERSION = "0.0.1"
+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>.