object-view 0.4.0

data/lib/object_view.rb

@@ -0,0 +1,16 @@
+require 'object_view/page.rb' 
+require 'object_view/element.rb' 
+require 'object_view/body'
+require 'object_view/head'
+require 'object_view/header'
+require 'object_view/javascript_file'
+require 'object_view/div'
+require 'object_view/span'
+require 'object_view/javascript'
+require 'object_view/table'
+require "object_view/link"
+require "object_view/chart_data"
+
+
+module ObjectView
+end

data/lib/object_view/body.rb

@@ -0,0 +1,12 @@
+require_relative './element'
+module ObjectView 
+
+  class Body < Element
+    def initialize
+      puts "Creating body"
+      super
+      @tag = "body"
+    end
+  
+  end
+end

data/lib/object_view/chart_data.rb

@@ -0,0 +1,22 @@
+@@chart_id = 0
+
+
+module ObjectView
+  # ajax_method_for_params specifies a javascript method that will be called by ajax update script to retrieve non-static params
+  # This method needs to be added to page and returns a string in the form :  "a=b&c=d&e=f"
+  class ChartData
+    attr_accessor :id, :series, :label, :chart_type, :x_axis_label, :y_axis_labels, :ajax_url, :ajax_params, :ajax_refresh_seconds, :ajax_method_for_params
+  
+    def initialize(type)
+      @@chart_id += 1
+      @ajax_method_for_params = nil
+      @ajax_params = Hash.new
+      @id = "chart_#{@@chart_id}"
+      @chart_type = type
+      @series = []
+      @x_axis_label = "Time"
+      @y_axis_labels = ["Count"]
+    end
+  
+  end
+end

data/lib/object_view/chart_load_javascript.rb

@@ -0,0 +1,127 @@
+require_relative "./page"
+
+module ObjectView
+  class ChartLoadJavascript < ObjectView::Javascript
+  
+    def initialize(chart_load_js_content)
+      super()
+      add "
+      //  Chart Partial erb:  <%= Time.new.to_s%>
+
+      function drawChart() {
+          #{chart_data_load_script(chart_load_js_content)}
+       }
+
+      function initializeChart() {
+    	  google.load('visualization', '1', {packages:['corechart']});
+    	  google.setOnLoadCallback(drawChart);
+      }
+      initializeChart();
+       "
+    end    
+    
+    def chart_data_load_script(chart_load_js_content)
+      script = ""
+     	chart_load_js_content.each do |chart_data|  
+        chart_object = "Error"
+        if (chart_data.chart_type == :line)
+          chart_object = "LineChart"
+        elsif(chart_data.chart_type == :pie)
+          chart_object = "PieChart"
+        elsif(chart_data.chart_type == :stacked_area)
+          chart_object = "AreaChart"
+        elsif(chart_data.chart_type == :area)
+          chart_object = "AreaChart"
+        elsif(chart_data.chart_type == :stepped_area)
+          chart_object = "SteppedAreaChart"
+        else
+          raise ("chart_data needs a valid 'chart_type':  :line or :pie")
+        end
+      
+  #      Rails.logger.info "Chart data y-axis (as js render): #{chart_data.y_axis_labels}"
+        y_axis_elements = ""
+        chart_data.y_axis_labels.each do |label|
+          y_axis_elements += "'#{label}'"
+          if (chart_data.y_axis_labels.last != label)
+            y_axis_elements += ", "
+          end
+        end
+
+  #      script += "// #{chart_data.series}\n"
+        script += "var chartArray = ([ \n" 
+        script += "['#{chart_data.x_axis_label}', #{y_axis_elements}], \n"
+        show_legend = false
+     	  chart_data.series.each do |data|
+       	  script += "         "
+          script += "["
+          if (data.length > 2)
+            show_legend = true
+          end
+
+          (0..data.length - 1).each do |i|
+            data_item = data[i]
+            if (i == 0)
+              script += "'#{data_item}'"
+            else
+              script += "#{data_item}"
+            end
+            if (i != data.length - 1)
+              script += ", "
+            end
+          end
+          script += "]"
+          if (chart_data.series.last != data)
+            script += ","
+            script += "\n"
+          end
+     	  end    
+     	  script += "    ]);\n"
+     	  script += "      var chartData = google.visualization.arrayToDataTable(chartArray); \n" 
+     	  script += "      var chart = new google.visualization.#{chart_object}(document.getElementById('#{chart_data.id}'));\n"
+        if (chart_data.chart_type == :pie)
+          script += "
+           	  var options = {
+           	 	  title: '#{chart_data.label}'
+           	 }
+             "
+        else
+          if (show_legend)
+            legend_value = ""
+          else
+            legend_value = "legend: 'none',"
+          end
+
+
+          if(chart_data.chart_type == :stacked_area)
+        
+            script += "
+             	  var options = {
+                  vAxis: {minValue: 0},
+                  isStacked: true,
+             	 	  title: '#{chart_data.label}',
+          		    displayAnnotations: true,
+             		  curveType: 'function',
+          		    fontSize: 10
+             	 }
+               "
+           else        
+              script += "
+             	  var options = {
+             	 	  title: '#{chart_data.label}',
+                  #{legend_value}
+          		    displayAnnotations: true,
+             		  curveType: 'function',
+          		    fontSize: 10
+             	 }
+               "
+             end
+         end
+         script += "   chart.draw(chartData, options);\n"
+       
+       end
+       return script    
+    end  
+  end
+  
+  
+end

data/lib/object_view/chart_load_javascript_ajax.rb

@@ -0,0 +1,204 @@
+require_relative "./page"
+require 'uri'
+
+
+module ObjectView
+  class ChartLoadJavascriptAjax < ObjectView::Javascript
+  
+    def initialize(chart_load_js_content, ajax_refresh_seconds = nil, prepend_script = "")
+      super()
+    
+    
+    
+      script = "
+      #{prepend_script}
+    
+      var _nextTimeToDraw = jQuery.now() + 1000;
+      var _doingPeriodicCheck = false;
+    
+      function periodicCheck() {
+        if (_initializedCharts) {
+          if (!_doingPeriodicCheck) {
+            _doingPeriodicCheck = true;
+            var now = jQuery.now();
+            if (_nextTimeToDraw != null) {
+              if (now > _nextTimeToDraw) {
+                _doingPeriodicCheck = false;
+                if (_currentlyDrawing == false) {
+                  _nextTimeToDraw = null;
+                  drawChart();
+                } else {
+                }
+              }
+            }
+            _doingPeriodicCheck = false;
+          }
+        } else {
+          console.log('Waiting for google charts to initialize');
+          initializeChart();
+        }
+      }
+    
+    
+      var _chartRequestMade = false;
+      function makeChartDrawRequest(time) {
+        var nextTime = jQuery.now() + time;
+        if ((_nextTimeToDraw == null) || (nextTime < _nextTimeToDraw)) {
+          _nextTimeToDraw = nextTime;
+        }
+        console.log('Request to drawChart queued for: ' + _nextTimeToDraw);
+      }
+    
+      function clearCharts() {
+        #{clear_script_for_each_chart(chart_load_js_content)}
+      }
+    
+    
+        _currentlyDrawing = false;
+        function drawChart() {
+            console.log('drawChart called');
+            try {
+                _currentlyDrawing = true;
+                console.log('Drawing charts.');
+                //alert('drawChart()');
+                 #{chart_data_load_script(chart_load_js_content)}
+                 console.log('Finished drawing charts.');
+        " 
+      if (ajax_refresh_seconds != nil)   
+        script += "     
+                 console.log('finished drawing chart.  Queuing another drawChart request.');
+      
+                 makeChartDrawRequest(#{ajax_refresh_seconds * 1000});\n
+                 _currentlyDrawing = false;
+        "
+      end
+    
+      script += "    
+            }  catch(error) {
+               console.log('Exception drawing chart: ' + error);
+               _currentlyDrawing = false;
+               makeChartDrawRequest(1000);
+            }
+            _currentlyDrawing = false;
+          }
+       "
+    	chart_load_js_content.each do |chart_data|  
+        script += " $('##{chart_data.id}').html('<h2 style=\"color: #aaaaaa\">Building Chart...</h2>'); \n"
+      end
+     
+       script +=  "  initializeChart();\n;"
+       script +=  "  setInterval(periodicCheck, 500);\n"
+       if (ajax_refresh_seconds != nil)
+         script += " makeChartDrawRequest(1000); \n"
+       else
+         script += "makeChartDrawRequest(1000);\n"
+       end
+       add script
+    end    
+  
+  
+    def clear_script_for_each_chart(chart_load_js_content) 
+      script = ""
+     	chart_load_js_content.each do |chart_data|  
+        chart_data.id
+        script += "  $('##{chart_data.id}').html('<h3 style=\"color: #aaaaaa\">Building Chart</h3>');\n"
+      end
+      return script
+    end  
+  
+    
+    def chart_data_load_script(chart_load_js_content)
+      script = ""
+     	chart_load_js_content.each do |chart_data|  
+        params = []
+        
+        chart_data.ajax_params.each do |name, value|
+        #  params_string += "#{name}=#{value}&"
+          params << [name, value]
+        end
+        # if (params_string.length > 0)
+        #   params_string = params_string[0..params_string.length - 2]
+        # end
+        params_string = URI.encode_www_form(params)
+      
+      
+        chart_object = "Error"
+        additional_options_script = ""
+        if (chart_data.chart_type == :line)
+          chart_object = "LineChart"
+        elsif(chart_data.chart_type == :pie)
+          chart_object = "PieChart"
+        elsif(chart_data.chart_type == :stacked_area)
+          chart_object = "AreaChart"
+          additional_options_script = "   options['isStacked'] = true;\n"
+        elsif(chart_data.chart_type == :area)
+          chart_object = "AreaChart"
+        elsif(chart_data.chart_type == :stepped_area)
+          chart_object = "SteppedAreaChart"
+        else
+          raise ("chart_data needs a valid 'chart_type':  :line or :pie")
+        end
+      
+        if (params_string.length > 0)
+          script += "  var params = '#{params_string}';\n" 
+          if (chart_data.ajax_method_for_params != nil)
+            script += "  params = params + '&' + #{chart_data.ajax_method_for_params};\n" 
+          end
+        else
+          if (chart_data.ajax_method_for_params != nil)
+            script += "  var params = #{chart_data.ajax_method_for_params};\n" 
+          else
+            script += "  var params = '';\n" 
+          end
+        end
+      
+        script += "
+          $.ajax({
+            type: 'POST',
+            url: '#{chart_data.ajax_url}',
+            data: params,
+            dataType: 'text',
+            success: function(response) {
+              //alert(\"Response: \" + response);
+              var chartData = jQuery.parseJSON(response);
+
+              //alert('Json: ' + chartData);
+              var seriesJson = chartData.series;
+
+              var options = chartData.options;
+              #{additional_options_script}
+              //alert('Options: ' + options);
+            
+               var series = [];
+               for (var i = 0; i < seriesJson.length; i++) {
+                 var dataPointJson = seriesJson[i];
+                 var dataPoint = [];
+                 dataPoint.push(dataPointJson[0].toString());
+                 for (var j = 1; j < dataPointJson.length; j++) {
+                   dataPoint.push(dataPointJson[j]);
+                 }
+                 series.push(dataPoint);
+              }
+
+              // var number = 5
+              // var series = [ ['Time', 'Count'], [number.toString(), 0], ['04/30/2013', 0], ['05/28/2013', 0], ['06/25/2013', 0]  ];
+              var chartElementId = '#{chart_data.id}';
+              //alert('Series: ' + series);
+              var chartData = google.visualization.arrayToDataTable(series);
+              var chart = new google.visualization.#{chart_object}(document.getElementById(chartElementId));
+            
+               chart.draw(chartData, options);
+            },
+            error: function(XMLHttpRequest, textStatus, errorThrown) {
+              $('##{chart_data.id}').html('<h3>Error getting chart data - QA server may be down.</h3>');
+            }
+          });
+          "
+       end
+       return script    
+    end  
+  
+  end
+  
+  
+end

data/lib/object_view/div.rb

@@ -0,0 +1,16 @@
+require_relative './span'
+
+
+module ObjectView 
+
+  class Div < Element 
+  
+    def initialize(content = nil)
+      super()
+      @tag = "div"
+      if (content != nil)
+        self.add content
+      end
+    end
+  end
+end

data/lib/object_view/element.rb

@@ -0,0 +1,153 @@
+require_relative './object_view_error'
+
+module ObjectView 
+
+  class Element 
+    attr_accessor :tag, :attributes, :single_line, :acceptable_children
+    attr_reader   :children
+  
+    def initialize
+      @tab = "  "
+      @single_line = false
+      @tag = nil
+      @attributes = Hash.new
+      @children = []
+      @acceptable_children = [String, Element]
+    end
+  
+  
+    def find_element_with_tag(tag)
+      found = []
+      @children.each do |child|
+        if (child.is_a?(Element)) && (child.tag == tag)
+          found << child
+        end
+      end
+      if (found.length == 0)
+        return nil
+      elsif (found.length == 1)
+        return found[0]
+      else
+        return found
+      end
+        
+    end
+  
+    def attr(name, value)
+      @attributes[name] = value
+    end
+  
+    def on_click=(value)
+      self.attr("onclick", value)
+    end
+    
+    def style=(the_style)
+      self.attr("style", the_style)
+    end
+
+    def css_class=(value)
+      self.attr("class", value)
+    end
+
+    def id=(value)
+      self.attr("id", value)
+    end
+
+    def is_acceptable_child?(child)
+      @acceptable_children.each do |good_class|
+        if (child.is_a?(good_class)) 
+          return true
+        end
+      end
+      return false
+    end
+  
+    def add(element_or_string)
+      if (self.is_acceptable_child?(element_or_string))
+        @children << element_or_string
+      elsif (element_or_string.is_a?(Array))
+        element_or_string.each do |child|
+          add child
+        end
+      else
+        raise "Parent: #{self.tag} - Attempt to add an element that is not a valid child, and not an ObjectView::Element.  Class of element: #{element_or_string.class.name}:  #{element_or_string}\nTag of parent: #{self.tag}.\nAcceptable children: #{@acceptable_children.join(',')}"
+      end
+      
+      return element_or_string
+    end
+    
+    def add_with_tag(tag, content = nil)
+      element = Element.new
+      element.tag = tag
+      if (content != nil)
+        element.children << content
+      end
+      element.single_line = false
+      self.children << element
+      return element
+    end
+    
+    def <<(item)
+      self.children << item
+    end
+
+    def render_children(indent = 0)
+      html = StringIO.new
+      @children.each do |child|
+        if (indent != nil)
+          if (!self.single_line)
+            html << "\n"
+          end
+          html << @tab * indent
+        end
+        if (child.class.name == "String")
+          html << child
+        else
+          child_html = child.render(indent)
+          html << child_html
+        end
+      end
+      return html.string
+    end
+  
+    def render_attributes
+      html = StringIO.new
+      if (@attributes.length > 0)
+        @attributes.each do |name, value|
+          html << " #{name}=\"#{value}\""
+        end
+      end
+      return html.string
+    end
+    
+    def render(indent = 0)
+      #Rails.logger.debug "Rendering: #{self}   Tag: #{self.tag}"
+      html = StringIO.new
+      if (indent != nil)
+        html << (@tab * indent) 
+      end
+      html << "<#{tag}#{render_attributes}>"
+      if (self.single_line)
+        html << "#{render_children(nil)}" 
+      else
+        if (indent == nil)
+          html <<  render_children(indent)
+        else
+          html <<  render_children(indent + 1)
+        end
+      end
+    
+    
+      if (!self.single_line)
+        html << "\n"
+        if (indent != nil)
+          html << @tab * indent 
+        end
+      end
+      
+      html << "</#{tag}>\n"
+      return html.string
+    end
+  
+  end
+end

data/lib/object_view/head.rb

@@ -0,0 +1,11 @@
+require_relative './element'
+module ObjectView 
+
+  class Head < Element
+    def initialize
+      super
+      @tag = "head"
+    end
+  
+  end
+end

data/lib/object_view/header.rb

@@ -0,0 +1,14 @@
+require_relative './element'
+
+module ObjectView 
+
+  class Header < Element
+    def initialize(n, text)
+      super()
+      @single_line = true
+      @tag = "h#{n}"
+      add text
+    end
+  
+  end
+end

data/lib/object_view/javascript.rb

@@ -0,0 +1,15 @@
+require_relative './element'
+
+module ObjectView 
+  class Javascript < Element
+  
+    def initialize(content = nil)
+      super()
+      attr("type", "text/javascript")
+      @tag = "script"
+      if (content != nil)
+        add content
+      end
+    end
+  end
+end

data/lib/object_view/javascript_file.rb

@@ -0,0 +1,17 @@
+require_relative './element'
+
+module ObjectView 
+
+  class JavascriptFile < Element
+  
+    def initialize(file)
+      super()
+      self.single_line = true
+      attr("type", "text/javascript")
+      attr("src", file)
+      @tag = "script"
+    end
+  
+  
+  end
+end

data/lib/object_view/link.rb

@@ -0,0 +1,18 @@
+module ObjectView 
+
+  class Link < Element 
+  
+    def initialize(href = nil, label = nil)
+      super()
+      @tag = "a"
+      
+      if (href != nil)
+        self.attr("href", href)
+      end
+      
+      if (label != nil)
+        self.add label
+      end
+    end
+  end
+end

data/lib/object_view/object_view_error.rb

@@ -0,0 +1,9 @@
+class ObjectViewError < StandardError
+  attr_reader :original
+  
+  def initialize(msg, original=nil);
+    super(msg);
+    @original = original;
+  end
+  
+end

data/lib/object_view/page.rb

@@ -0,0 +1,59 @@
+require_relative './element'
+require_relative './body'
+require_relative './head'
+require_relative './header'
+require_relative './javascript_file'
+require_relative './div'
+require_relative './span'
+require_relative './javascript'
+require_relative './table'
+require_relative "./link"
+require_relative "./chart_data"
+require_relative "./chart_load_javascript"
+require_relative "./chart_load_javascript_ajax"
+
+
+
+module ObjectView 
+  class Page < Element
+    attr_accessor :head, :body, :title, :title_div, :top_div
+
+    def initialize
+      super
+      puts "Element tag: #{@tag}"
+      self.tag = "html"
+      @head = Head.new
+      @title = "No Title"
+      self.add @head
+      @body = Body.new
+      self.add @body
+      @top_div = self.body.add Div.new
+      @title_div = self.body.add Div.new
+      @title = "No Title"
+      @acceptable_children = [Head, Body]
+    end
+    
+    def displayed_title=(title)
+      self.title_div.add(Header.new(1, title))
+    end
+    
+    def title=(title)
+      title_element = @head.find_element_with_tag("title")
+      if (title_element == nil)
+        title_element = @head.add_with_tag("title", title)
+      end
+      title_element.add(title)
+    end
+  
+    def use_google_charts(chart_load_js_content)
+      self.head.add JavascriptFile.new("https://www.google.com/jsapi")
+      self.body.add ChartLoadJavascript.new(chart_load_js_content)
+    end
+
+    def use_google_charts_ajax(chart_load_js_content, refresh_seconds = nil, prepend_js_script = "")
+      self.head.add JavascriptFile.new("https://www.google.com/jsapi")
+      self.body.add ChartLoadJavascriptAjax.new(chart_load_js_content, refresh_seconds, prepend_js_script)
+    end
+  
+  end
+end

data/lib/object_view/span.rb

@@ -0,0 +1,13 @@
+module ObjectView 
+
+  class Span < Element 
+  
+    def initialize(content = nil)
+      super()
+      @tag = "span"
+      if (content != nil)
+        self.add content
+      end
+    end
+  end
+end

data/lib/object_view/table.rb

@@ -0,0 +1,122 @@
+module ObjectView 
+
+  class Table < Element 
+    attr_reader   :tbody, :thead
+    
+    def initialize
+      super()
+      @tag = "table"
+    end
+
+    def header_row(labels = nil)
+      self.add @thead = THead.new
+      row = THeadRow.new
+      @thead.add row
+      if (labels != nil)
+        labels.each do |label|
+          row.cell(label)
+        end
+      end
+      return row
+    end
+  
+    def row(cell_data = nil, cell_attributes = nil)
+      if (@tbody == nil)
+        self.add @tbody = TBody.new
+      end
+      row = @tbody.row
+      if (cell_data != nil)
+        cell_data.each do |element|
+          cell = row.cell(element)
+          if (cell_attributes != nil)
+            cell_attributes.each do |name, value|
+              cell.attr(name.to_s, value)
+            end
+          end
+        end
+      end
+      return row
+    end
+  end
+
+  class THead < Element
+    def initialize
+      super()
+      self.single_line = true
+      @tag = "thead"
+    end
+    
+    def row
+      @row = THeadRow.new
+      self.add(@row)
+      return @row
+    end
+  
+  end
+
+  class TBody < Element
+    def initialize
+      super()
+      @tag = "tbody"
+    end
+
+    def row
+      @row = TRow.new
+      self.add(@row)
+      return @row
+    end
+  end
+
+  
+
+  class TRow < Element
+    def initialize
+      super()
+      @tag = "tr"
+    end
+  
+    def cell(content = nil)
+      cell = TCell.new
+      if (content != nil)
+        cell.add content
+      end
+      self.add cell
+      return cell
+    end
+  end
+  
+  class THeadRow < TRow
+    def initialize
+      super()
+      @tag = "tr"
+    end
+
+    def cell(content = nil)
+      cell = THeadCell.new
+      if (content != nil)
+        cell.add content
+      end
+      self.add cell
+      return cell
+    end
+  end
+
+
+  class TCell < Element
+    def initialize
+      super()
+      self.single_line = true
+      @tag = "td"
+    end
+  end
+  
+  
+  class THeadCell < TCell
+    def initialize
+      super()
+      self.single_line = true
+      @tag = "th"
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: object-view
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
+platform: ruby
+authors:
+- Mike Moore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-10 00:00:00.000000000 Z
+dependencies: []
+description: Object oriented approach to generating HTML content
+email: m.moore.denver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/object_view/body.rb
+- lib/object_view/chart_data.rb
+- lib/object_view/chart_load_javascript.rb
+- lib/object_view/chart_load_javascript_ajax.rb
+- lib/object_view/div.rb
+- lib/object_view/element.rb
+- lib/object_view/head.rb
+- lib/object_view/header.rb
+- lib/object_view/javascript.rb
+- lib/object_view/javascript_file.rb
+- lib/object_view/link.rb
+- lib/object_view/object_view_error.rb
+- lib/object_view/page.rb
+- lib/object_view/span.rb
+- lib/object_view/table.rb
+- lib/object_view.rb
+homepage: https://github.com/mikejmoore/object-view
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/object_view
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Object oriented views
+test_files: []
+has_rdoc: