hiro_format 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ff2b0d324bdb47219ab870ce7e5f2cdb1e3f29d
-  data.tar.gz: c0a9629151e1091c587e4ac3f0fbb021d75431ef
+  metadata.gz: fbd05ad43abfdead030270847cfbb1ee175059d3
+  data.tar.gz: b131ba35f8d03322e97bab7d2f8a49e92ae55356
 SHA512:
-  metadata.gz: 648fade5b38f62a3a469dbe5b88cf4ead5c185d1137318b76c306ba516cd8f0ab3ce671d02f56943fafff148909ecb043597d76388c1d01cabc489c7beb38775
-  data.tar.gz: a06d3941839965b8baf697cc5b09493b6df42595a5c0de876800d1e49613b6113521221270fa78635fe098668b9bd45b2dbdadeb5b599d98df4bc1be3f76645d
+  metadata.gz: 9f55048df4a8dcaa3c73f7ba03740ce68e55f672ab0295831759bec7591bd390d0fa93ce84e6c20feb5bb3761b371697ac32aa8eacf8e7ad412914f15ce77ec9
+  data.tar.gz: ad68d0cf118f665c65e1f4bd4921d84e8ab91bbfd7fb1ed004637eb441331bc96a0ba1a506217d71d3ffd9668668fc1c56b6da9a9088e5ac174ff953cffd451f

data/Formatting.md

@@ -0,0 +1,34 @@
+# Supported Recipes
+
+  FORMATTER_LIST = {
+
+    :date => {:time_format => "%Y-%m-%d", :applicable => [Date, DateTime], :rest => "0000-00-00" },
+    :jp_date => {:time_format => "%Y-%m-%d", :applicable => [Date, DateTime], :rest => "0000-00-00" },
+    :us_date => {:time_format => "%m-%d-%Y", :applicable => [Date, DateTime], :rest => "0000-00-00" },
+    :euro_date => {:time_format => "%d-%m-%Y", :applicable => [Date, DateTime], :rest => "0000-00-00" },
+    :obvious_date => {:time_format => "%d-%b-%Y", :applicable => [Date, DateTime], :rest => "0000-00-00" },
+    :machine_date => {:time_format => "%Y%m%d", :applicable => [Date, DateTime], :rest => "00000000" },
+
+    :datewday => {:time_format => "%Y-%m-%d (%a)", :applicable => [Date, DateTime], :rest => "0000-00-00 (---)" },
+    :jp_datewday => {:time_format => "%Y-%m-%d (%a)", :applicable => [Date, DateTime], :rest => "0000-00-00 (---)" },
+    :us_datewday => {:time_format => "%m-%d-%Y (%a)", :applicable => [Date, DateTime], :rest => "00-00-0000 (---)" },
+    :euro_datewday => {:time_format => "%d-%m-%Y (%a)", :applicable => [Date, DateTime], :rest => "00-00-0000 (---)" },
+
+    :datetime => {:time_format => "%Y-%m-%d %H:%M", :applicable => [Date, DateTime, Time], :rest => "0000-00-00" },
+    :datetimesecond => {:time_format => "%Y-%m-%d %H:%M%s", :applicable => [Date, DateTime, Time], :rest => "0000-00-00" },
+    :jp_datetime => {:time_format => "%Y-%m-%d %H:%M", :applicable => [Date, DateTime, Time], :rest => "0000-00-00" },
+    :jp_datetimesecond => {:time_format => "%Y-%m-%d %H:%M:%s", :applicable => [Date, DateTime, Time], :rest => "0000-00-00 00:00:00" },
+    :us_datetime => {:time_format => "%m-%d-%Y %H:%M", :applicable => [Date, DateTime, Time], :rest => "00-00-0000  00:00" },
+    :us_datetimesecond => {:time_format => "%m-%d-%Y %H:%M:%s", :applicable => [Date, DateTime, Time], :rest => "00-00-0000 00:00:00" },
+    :euro_datetime => {:time_format => "%d-%m-%Y %H:%M", :applicable => [Date, DateTime, Time], :rest => "00-00-0000 00:00" },
+    :euro_datetimesecond => {:time_format => "%d-%m-%Y %H:%M:%s", :applicable => [Date, DateTime, Time], :rest => "0000-00-00 00:00:00" },
+    :machine_datetime => {:time_format => "%Y%m%d%H%M", :applicable => [Date, DateTime], :rest => "000000000000" },
+
+    # Fixnum is deprecated in Ruby > 2.4.0 should be removed soon.
+    :digit6 =>{:format => "%06d", :applicable => [Fixnum, Integer, Float], :rest => "000000"},
+    :digit2 =>{:format => "%02d", :applicable => [Fixnum, Integer, Float], :rest => "00"},
+
+    :commify =>{:function => "commify", :applicable => [Integer, Float, String, NilClass], :rest => ""},
+    :euro_commify =>{:function => "euro_commify", :applicable => [Integer, Float, String, NilClass], :rest => ""},
+
+  }.freeze

data/README.md

@@ -5,6 +5,13 @@ HiroFormat (hiro_format) is a text formatter.
 It converts ruby variables into formatted text by predefined recipe.
 It also supports ANSI color display for console applications, and html class handling to have colorful texts.
 
+This formatter uses ruby symbols to specify formats.
+
+It is nice to have a def like "MyString".red , but by using symbols it gives you much more flexibilities to handle data of database objects, arrays, hashes.
+
+See 'Usage hint for Active Record  / Sequel users'
+
+
 ## Still Buggy
 
 Sorry, it is still in very early stage of development. If you use this, please update the gem frequently.
@@ -27,7 +34,7 @@ Or install it yourself as:
 
     $ gem install hiro_format
 
-## Usage samples
+## Usage
 
 ~~~ruby
 require 'hiro_format'
@@ -36,26 +43,71 @@ puts "This is a text string".color(:red_marker).to_s
 value = 123456.78
 puts value.formatting(:commify).color(:blue).to_s # 123,456.78 (Blue color)
 puts value.formatting(:euro_commify).color(:red).to_s # 123.456,78 (Red color)
+puts value.formatting(:euro).to_s # € 123.456,78
+
 puts Formatting.new(Date.today, :jp_date).color(:magenta_marker).to_s # 2017-12-24
 puts Date.today.formatting(:euro_date).color(:reverse).to_s # 24-12-2017
 puts Formatting.new(Date.today, :us_date).color("magenta").to_span # <span class="magenta">12-24-2017</span>
 # pzm means Plus/Zero/Minus
-puts -1.formatting(:digit2).pzm?(:green, :hide, :red).to_s # -01 (Red)
-puts 0.formatting(:digit2).pzm?(:green, :hide, :red).to_s #  (No show)
-puts 1.formatting(:digit6).pzm(value, :green, :hide, :red).to_s # 000002 (Green)
+puts -1.formatting(:digit6).pzm?(12, [:green, :hide, :red]).to_s # -01 (Green)
+puts 0.formatting(:digit6).pzm?(0, [:green, :hide, :red]).to_s #  (No show)
+puts 1.formatting(:digit6).pzm([:green, :hide, :red]).to_s # 000002 (Green)
+~~~
+
+See formatting_sample.rb for more examples.
+
+
+## Usage hint for Active Record  / Sequel users
+
+~~~ruby
+# require "hiro_format" # you need gem install hiro_format
+require "./lib/hiro_format/formatting"
+require "./lib/hiro_format/coloring"
+
+FIELD_LIST = [
+  {:title => "ID", :key => :id, :format => nil},
+  {:title => "Name", :key => :name, :format => :none, :color => "blue_class"},
+  {:title => "BirthDay", :key => :bday, :format => :obvious_date, },
+  {:title => "Assets", :key => :assets, :format => :euro, :pzm => ["green_class", "blue_class", "red_class"]},
+]
+# @records = MyFriend.all
+# For test without database engine
+@records = [
+  {:id => 1, :name => "John", :bday => Date.parse('2000-01-02'), :assets => '1000000'},
+  {:id => 2, :name => "Kevin", :bday => Date.parse('2000-04-12'), :assets => '-10000'},
+]
+puts "<table>"
+puts "<tr>"
+FIELD_LIST.each do |field|
+  puts "<th>#{field[:title]}</th>"
+end
+puts "</tr>"
+@records.each do |my_friend|
+  puts "<tr>"
+  FIELD_LIST.each do |field|
+    if field[:pzm]
+      puts my_friend[field[:key]].formatting(field[:format]).pzm(field[:pzm]).to_td
+    else
+      puts my_friend[field[:key]].formatting(field[:format]).color(field[:color]).to_td
+    end
+  end
+  puts "</tr>"
+end
+puts "</table>"
 ~~~
 
 ## Formatting Recipes
 
 :date, :datetime, :machine_date, :commify, and more
 
-See Help file for details at : (TODO)
+See Help file for details : Formatting.md
 
 ## Coloring Recipes
 
 :hide, :red, :red_bold, :red_back, :red_marker, :yellow, :reverse, and more
 
-See Help file for details at : (TODO)
+Run formatting_sample.rb to see a list of supported recipes.
+
 
 ## TODO
 

data/lib/hiro_format/formatting.rb

@@ -34,11 +34,20 @@ require 'date'
       :machine_datetime => {:time_format => "%Y%m%d%H%M", :applicable => [Date, DateTime], :rest => "000000000000" },
 
 			# Fixnum is deprecated in Ruby > 2.4.0 should be removed soon.
-      :digit6 =>{:format => "%06d", :applicable => [Fixnum, Integer, Float], :rest => "000000"},
-      :digit2 =>{:format => "%02d", :applicable => [Fixnum, Integer, Float], :rest => "00"},
+      :digit6 => {:format => "%06d", :applicable => [Fixnum, Integer, Float], :rest => "000000"},
+      :digit2 => {:format => "%02d", :applicable => [Fixnum, Integer, Float], :rest => "00"},
 
-      :commify =>{:function => "commify", :applicable => [Integer, Float, String, NilClass], :rest => ""},
-			:euro_commify =>{:function => "euro_commify", :applicable => [Integer, Float, String, NilClass], :rest => ""},
+      :commify => {:function => "commify", :applicable => [Integer, Float, String, NilClass], :rest => ""},
+			:euro_commify => {:function => "euro_commify", :applicable => [Integer, Float, String, NilClass], :rest => ""},
+			:commify0 => {:function => "commify0", :applicable => [Integer, Float, String, NilClass], :rest => ""},
+			:euro_commify0 => {:function => "euro_commify0", :applicable => [Integer, Float, String, NilClass], :rest => ""},
+			:commify4 => {:function => "commify4", :applicable => [Integer, Float, String, NilClass], :rest => ""},
+			:euro_commify4 => {:function => "euro_commify4", :applicable => [Integer, Float, String, NilClass], :rest => ""},
+
+			:japanese_yen => {:function => "japanese_yen", :applicable => [Integer, Float, String, NilClass], :rest => ""},
+			:euro => {:function => "euro", :applicable => [Integer, Float, String, NilClass], :rest => ""},
+
+			:hide => {:format => "", :applicable => [], :rest => ""},
 		}.freeze
 
     def initialize(data, formatting_option=nil)
@@ -51,26 +60,19 @@ require 'date'
 			self
     end
 
-    def pzm(plus, zero, minus)
-      judge = @data.to_f
-      if judge > 0.0
-        @color_scheme = plus
-      elsif judge < 0.0
-        @color_scheme = minus
-      else
-        @color_scheme = zero
-      end
+    def pzm(plus_zero_minus)
+			pzm?(@data, plus_zero_minus)
 			self
     end
 
-		def pzm?(judge, plus, zero, minus)
+		def pzm?(judge, plus_zero_minus)
       judge = judge.to_f
       if judge > 0.0
-        @color_scheme = plus
+        @color_scheme = plus_zero_minus[0]
       elsif judge < 0.0
-        @color_scheme = minus
+        @color_scheme = plus_zero_minus[2]
       else
-        @color_scheme = zero
+        @color_scheme = plus_zero_minus[1]
       end
 			self
     end
@@ -123,67 +125,99 @@ require 'date'
     end
     alias show to_s
 
-		def to_tag(tag="div")
-			case @color_scheme
-      when :hide
-        content = ''
-      else
-				result = "<#{tag} class=\"#{@color_scheme}\">#{to_string}</#{tag}>"
+		def to_tag(tag="div", klass=nil)
+			klass = @color_scheme unless klass
+			if klass
+				result = "<#{tag} class=\"#{klass}\">#{to_string}</#{tag}>"
+			else
+				result = "<#{tag}>#{to_string}</#{tag}>"
       end
+			result
 		end
 
-		def to_div
-			to_tag("div")
+		def to_div(klass=nil)
+			klass = @color_scheme unless klass
+			to_tag("div", klass)
 		end
 
-		def to_span
-			to_tag("span")
+		def to_span(klass=nil)
+			klass = @color_scheme unless klass
+			to_tag("span", klass)
 		end
 
-		def to_td
-			to_tag("td")
+		def to_td(klass=nil)
+			klass = @color_scheme unless klass
+			to_tag("td", klass)
 		end
 
-		def self.commify(num)
-			case num.class.to_s
-			when 'Float', 'Integer'
-				return Formatting.commify_string(num.to_s)
-			when 'String'
-				return Formatting.commify_string(num)
-			when 'NilClass'
-				return "0"
-			else
-				return "#{num.class}"
-			end
-		end
-
-		def self.commify_string(num)
+		def self.commify_string(num, thousand_sparator=',', decimal_separator='.', decimal=0)
 			int, frac = *num.split(".")
-			int = int.gsub(/(\d)(?=\d{3}+$)/, '\\1,')
-			int << "." << frac if frac
+			int = int.gsub(/(\d)(?=\d{3}+$)/, "\\1#{thousand_sparator}")
+			if decimal > 0
+				int << "#{decimal_separator}"
+				#if frac
+					frac = "#{frac}000000"
+					int << frac[0..(decimal-1)]
+				#else
+				#	""
+				#end
+			end
 			int
 		end
 
-		def self.euro_commify(num)
-			case num.class.to_s
-			when 'Float', 'Integer'
-				return Formatting.euro_commify_string(num.to_s)
+		def self.commify_value(data, thousand_sparator=',', decimal_separator='.', decimal=0 )
+			case data.class.to_s
+			when 'Float'
+				return Formatting.commify_string(data.to_s, thousand_sparator, decimal_separator, decimal)
+			when 'Integer'
+				return Formatting.commify_string(data.to_s, thousand_sparator, decimal_separator, decimal)
 			when 'String'
-				return Formatting.euro_commify_string(num)
+				return Formatting.commify_string(data, thousand_sparator, decimal_separator, decimal)
 			when 'NilClass'
-				return "0"
+				if decimal == 0
+					return "0"
+				else
+					res = "0#{decimal_separator}00000000000"
+					return res[0..(decimal+1)]
+				end
 			else
 				return "#{num.class}"
 			end
 		end
 
-		def self.euro_commify_string(num)
-			int, frac = *num.split(".")
-			int = int.gsub(/(\d)(?=\d{3}+$)/, '\\1.')
-			int << "," << frac if frac
-			int
+		def self.commify(data)
+			Formatting.commify_value(data, ',', '.', 2)
+		end
+
+		def self.euro_commify(data)
+			Formatting.commify_value(data, '.', ',', 2)
+		end
+
+		def self.commify0(data)
+			Formatting.commify_value(data, ',', '.', 0)
+		end
+
+		def self.euro_commify0(data)
+			Formatting.commify_value(data, '.', ',', 0)
+		end
+
+		def self.commify4(data)
+			Formatting.commify_value(data, ',', '.', 4)
+		end
+
+		def self.euro_commify4(data)
+			Formatting.commify_value(data, '.', ',', 4)
+		end
+
+		def self.japanese_yen(data)
+			"¥ " + Formatting.commify_value(data, ',', '.', 0)
+		end
+
+		def self.euro(data)
+			"€" + Formatting.commify_value(data, '.', ',', 2)
 		end
 
+
 	end
 
 	class NilClass

data/lib/hiro_format/version.rb

@@ -1,3 +1,3 @@
 module HiroFormat
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/sample_active_record.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+#
+# require "hiro_format" # you need gem install hiro_format
+require "./lib/hiro_format/formatting"
+require "./lib/hiro_format/coloring"
+
+FIELD_LIST = [
+  {:title => "ID", :key => :id, :format => nil},
+  {:title => "Name", :key => :name, :format => :none, :color => "blue_class"},
+  {:title => "BirthDay", :key => :bday, :format => :obvious_date, },
+  {:title => "Assets", :key => :assets, :format => :euro, :pzm => ["green_class", "blue_class", "red_class"]},
+]
+# @records = MyFriend.all
+# For test without database engine
+@records = [
+  {:id => 1, :name => "John", :bday => Date.parse('2000-01-02'), :assets => '1000000'},
+  {:id => 2, :name => "Kevin", :bday => Date.parse('2000-04-12'), :assets => '-10000'},
+]
+puts "<table>"
+puts "<tr>"
+FIELD_LIST.each do |field|
+  puts "<th>#{field[:title]}</th>"
+end
+puts "</tr>"
+@records.each do |my_friend|
+  puts "<tr>"
+  FIELD_LIST.each do |field|
+    if field[:pzm]
+      puts my_friend[field[:key]].formatting(field[:format]).pzm(field[:pzm]).to_td
+    else
+      puts my_friend[field[:key]].formatting(field[:format]).color(field[:color]).to_td
+    end
+  end
+  puts "</tr>"
+end
+puts "</table>"

data/{formatting_samples.rb → sample_formatting.rb}

@@ -15,11 +15,26 @@ require "hiro_format/formatting"
 require "hiro_format/coloring"
 # require "pry" # gem install pry pry-byebug
 
-value = 123456.78
-print ":commify #{value.class}: "
-puts value.formatting(:commify).color(:blue).to_s
-print ":euro_commify #{value.class}: "
-puts value.formatting(:euro_commify).color(:red).to_s
+values = [1234567890.1234, 0]
+values.each do |value|
+  puts "Value: #{value}"
+  print ":commify: "
+  puts value.formatting(:commify).color(:blue).to_s
+  print ":euro_commify: "
+  puts value.formatting(:euro_commify).color(:red).to_s
+  print ":commify0: "
+  puts value.formatting(:commify0).color(:blue).to_s
+  print ":euro_commify0: "
+  puts value.formatting(:euro_commify0).color(:red).to_s
+  print ":commify4: "
+  puts value.formatting(:commify4).color(:blue).to_s
+  print ":euro_commify4: "
+  puts value.formatting(:euro_commify4).color(:red).to_s
+end
+
+puts "12345".formatting(:japanese_yen).color(:green).to_s
+puts "12345".formatting(:euro).color(:green).to_s
+
 puts Formatting.new(Date.today, :us_date).color(:magenta_marker).to_s
 puts Date.today.formatting(:euro_date).color(:reverse).to_s
 puts Date.today.formatting(:machine_date).color(:cyan_bold).to_s

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hiro_format
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Hiro Utsumi
@@ -46,18 +46,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- Formatting.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- formatting_samples.rb
 - hiro_format.gemspec
 - lib/hiro_format.rb
 - lib/hiro_format/coloring.rb
 - lib/hiro_format/formatting.rb
 - lib/hiro_format/version.rb
+- sample_active_record.rb
+- sample_formatting.rb
 homepage: https://github.com/gambaldia/hiro_format.git
 licenses: []
 metadata: {}