scheduled_resource 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27d68cd9863e57b1473f9c98b09ef6be468f8d66
-  data.tar.gz: 1d31544b38529bf2b7d4ffcd64c8fbb71bb27d50
+  metadata.gz: ea444d3e4889204a4908f8551a04f106a3f44790
+  data.tar.gz: b6291de573f780226d71b4f815d32214b7df5eb7
 SHA512:
-  metadata.gz: 1e246e4d439011ef2a3f0248b5c6f2fbf4f34718fafa494fec0afd606022c3bb9dd34ea58afa1dbccce9980c0e62255cf597d53b0bbe30c6a405674714632909
-  data.tar.gz: 548284a3a3abfa0da69c4220ecd85d78d228f640a7a9d031f5104b6b342e731afe01ddbbb224a2c8cbb12b02f91b1befc10a23511682b8b1761f4bf35f004dab
+  metadata.gz: cd239e9b46dd9bf90b8bd287ab8247b78b2f125a78e0a92bbdc34a5cf3522b3875fc7d2518c608c7026e19eea8951c779b1a8a5b5e20046228ceb47e78198332
+  data.tar.gz: e75af2e6464b0ee799c8f5a64582c9fff89357196ad535227877c5a8777f5f4346595e8bbb8bbd93477cb7f4e7d5ea7a6ee2ec92843c76a7b8c3c7d7a699a1df

data/lib/assets/javascripts/time_pix.js.coffee

@@ -9,6 +9,9 @@ class @TimePix            # Ultimately, an angular $service
     $('#scrollbar-hider').css('width', @pixWindow + 61 + 'px' )
 
 
+  ##############################################################################
+  # 'meta' part of latest returned json + overall display data
+  #
   @baseTime: 0
   @timeWindow: (3 * 3600)
   @pixWindow: 750         # Matching width of #scrolling-container
@@ -27,6 +30,7 @@ class @TimePix            # Ultimately, an angular $service
     @thi = @thi && Math.max( @thi, @meta.t2 ) || @meta.t2
     @inc = @meta.inc
     @timeWindow = @meta.visible_time if @meta.visible_time
+  ##############################################################################
 
   @next_hi: -> @thi + @timeWindow
   @next_lo: -> @tlo - @timeWindow
@@ -44,6 +48,12 @@ class @TimePix            # Ultimately, an angular $service
     "left: #{@secs_to_pix_scale(s - @baseTime)}px; " +
     "width: #{@secs_to_pix_scale(e-s)-4}px;"
 
+  # Reactjs prefers this variant
+  @style_geo_hash: (block) ->
+    [s, e] = [block.starttime, block.endtime]             # per margins V
+    left:  "#{@secs_to_pix_scale(s - @baseTime)}px"
+    width: "#{@secs_to_pix_scale(e-s)-4}px"
+
   @row_kind: (tag) ->  # may/may not belong here.
     tag.split('_')[0]
 
@@ -91,9 +101,9 @@ class @TimePix            # Ultimately, an angular $service
       r_vis_time = l_vis_time + @timeWindow
 
       if      r_vis_time > @thi
-        RsrcListCtrlScope.$apply RsrcListCtrlScope.more_data
+        @expand_data 'more_data'
       else if l_vis_time < @tlo
-        RsrcListCtrlScope.$apply RsrcListCtrlScope.less_data
+        @expand_data 'less_data'
     else
       if new Date() - @scroll_monitor.scroll_timestamp > 1000
         filter_justify_tweaks( sc ) # Try to make scrolled-off content visible
@@ -101,3 +111,11 @@ class @TimePix            # Ultimately, an angular $service
 
     setTimeout @scroll_monitor, 100
 
+
+  # Angular-vs-react issues
+  @expand_data: (method_name) -> 
+    if TopResourceSchedule?
+      TopResourceSchedule[method_name]() 
+    else
+      RsrcListCtrlScope.$apply RsrcListCtrlScope[method_name]
+    return

data/lib/scheduled_resource.rb

@@ -7,6 +7,7 @@
 require 'scheduled_resource/version'
 require 'scheduled_resource/resource_use_block'
 require 'scheduled_resource/helper'
+require 'scheduled_resource/config'
 
 require 'z_time_header'
 require 'z_time_header_day'
@@ -24,7 +25,7 @@ require 'z_time_label_hour'
 # schedule.  An instance ties together:
 #
 #  1. A resource class (eg Room),
-#  2. An id, and
+#  2. An id (string), and
 #  3. Strings / html snippets (eg, label, title) for the DOM.
 #
 # The id (2 above) is used to
@@ -41,15 +42,7 @@ require 'z_time_label_hour'
 #
 # Items 1 and 2 are are combined (with a '_') to form "tags" (ids) for the DOM.
 #
-# See also:              ResourceUseBlock.
-#
-#--
-# Config is loaded from config/schedule.yml:
-# all_resources::      Resources in display order.
-# rsrcs_by_kind::      A hash with resources grouped by kind (resource class).
-# rsrc_of_tag::        Indexed by text tag: kind_subid.
-# \visible_time::       Span of time window.
-#++
+# See also:              ResourceUseBlock, Config.
 #
 # When queried with an array of ids and a time interval, the class
 # method <tt>get_all_blocks(ids, t1, t2)</tt> of a <em>resource use</em>
@@ -63,172 +56,84 @@ require 'z_time_label_hour'
 #
 class ScheduledResource
 
-  CONFIG_FILE = "config/resource_schedule.yml"
-
-  class_attribute :config
-
-  # (ScheduledResource protocol) Returns a hash where each key is an
-  # <tt>rid</tt> and the value is an array of resource use
-  # blocks in the interval <tt>t1...t2</tt>, ordered by
-  # <tt>starttime</tt>.
-  #
-  # What <em>in</em> means depends on <em>inc</em>.  If inc(remental) is
-  # false, the client is building the interval from scratch.  If "hi", it is
-  # an addition to an existing interval on the high side.  Similarly
-  # for "lo".  This is to avoid re-transmitting blocks that span the
-  # current time boundaries on the client.
-  #
-  # Here the resource is a channel and the use blocks are programs.
-  #
-  # ==== Parameters
-  # * <tt>rids</tt> - A list of schedules resource ids (strings).
-  # * <tt>t1</tt>   - Start time.
-  # * <tt>t2</tt>   - End time.
-  # * <tt>inc</tt>  - One of nil, "lo", "hi" (See above).
-  #
-  # ==== Returns
-  # * <tt>Hash</tt> - Each key is an <tt>rid</tt> and the value is an array of resource use blocks in the interval, ordered by <tt>starttime</tt>.
-  def self.get_all_blocks(t1, t2, inc)
-    blockss = {}
-
-    config[:rsrcs_by_kind].each do |kind, rsrcs|
-      rub_class = block_class_for_resource_name kind
-      rids      = rsrcs.map{ |r| r.sub_id }
-      ru_blkss  = rub_class.get_all_blocks rids, t1, t2, inc
+  class_attribute :rsrc_of_tag
+  self.rsrc_of_tag = {}
+
+  class << self
+    # (ScheduledResource protocol) Returns a hash where each key is an
+    # <tt>rid</tt> and the value is an array of resource use
+    # blocks in the interval <tt>t1...t2</tt>, ordered by
+    # <tt>starttime</tt>.
+    #
+    # What <em>in</em> means depends on <em>inc</em>.  If inc(remental) is
+    # false, the client is building the interval from scratch.  If "hi", it is
+    # an addition to an existing interval on the high side.  Similarly
+    # for "lo".  This is to avoid re-transmitting blocks that span the
+    # current time boundaries on the client.
+    #
+    # Here the resource is a channel and the use blocks are programs.
+    #
+    # ==== Parameters
+    # * <tt>config</tt> - A configuration instance.
+    # * <tt>t1</tt>     - Start time.
+    # * <tt>t2</tt>     - End time.
+    # * <tt>inc</tt>    - One of nil, "lo", "hi" (See above).
+    #
+    # ==== Returns
+    # * <tt>Hash</tt> - Each key is an <tt>rid</tt>; value is a list of blocks.
+    def get_all_blocks(config, t1, t2, inc)
+      blockss = {}
+
+      config.rsrcs_by_kind.each do |kind, rsrcs|
+        rub_class = config.block_class_for_resource_name kind
+        rids      = rsrcs.map{ |r| r.sub_id }
+        ru_blkss  = rub_class.get_all_blocks rids, t1, t2, inc
+
+        add_rubs_of_kind kind, ru_blkss, blockss
+      end
 
-      add_rubs_of_kind kind, ru_blkss, blockss
+      blockss
     end
 
-    blockss
-  end
-
-
-  # ==== Parameters
-  # * <tt>name</tt>  - The class name (string) of a schedule resource.
-  #
-  # ==== Returns
-  # * <tt>Class</tt> - The class representing the <em>use</em> of that resource for an interval of time.
-  def self.block_class_for_resource_name( name )
-    config[:block_class_for_resource_kind][name].constantize
-  end
-
-
-  # ==== Returns
-  # * <tt>Array[ScheduledResource]</tt> - List of configured ScheduledResources.
-  def self.resource_list; config[:all_resources] end
-
-  # ==== Returns
-  # * <tt>Time</tt> - The configured width of the visible time window.
-  def self.visible_time;  config[:visible_time] end
-
-
-  #--
-  # Restore configuration from session.
-  #
-  # When we depend on data in the configuration to satisfy a query we are not
-  # being RESTful.  On the other hand we are not maintaining changeable state
-  # here -- it's just a cache.  If there <em>were</em> changeable state it
-  # would likely be kept, eg, in a per-user table in the database.
-  #++
-  def self.ensure_config( session ) # :nodoc:
-    return if (self.config ||= session[:schedule_config])
-
-    config_from_yaml( session )
-  end
-
-
-  # ToDo: Generalize this so configuration can be loaded on per-user.
-  # Process configuration file.
-  def self.config_from_yaml( session )
-    config_from_yaml1
-    config_from_yaml2 session
-    config
-  end
-
+    def compose_tag( kind, sub_id ); "#{kind}_#{sub_id}" end
 
-  private
-  # A caching one-of-each-sort constructor.
-  #
-  # ==== Parameters
-  # * <tt>kind</tt>   - Class name (string) of a scheduled resource.
-  # * <tt>sub_id</tt> - Id (string), selecting a resource instance.  The two are combined and used as a unique tag in the DOM as id and class attributes as well as in server code.
-  def self.get_for( kind, sub_id )
-    tag = compose_tag( kind, sub_id )
-    config[:rsrc_of_tag][ tag ] || self.new( kind, sub_id )
-  end
-
-  def self.compose_tag( kind, sub_id ); "#{kind}_#{sub_id}" end
+    def make_resource_of_kind( klass, rid )
+      klass = klass.constantize if klass.is_a? String # ToDo: Trim this.
+      get_for( klass.name, rid )
+    end
 
-  def self.config_from_yaml1()
-    self.config = { all_resources: [],
-                    rsrc_of_tag: {},
-                    block_class_for_resource_kind: {}
-                   }
-    yml = YAML.load_file CONFIG_FILE
 
-    yml['ResourceKinds'].each do |key, val| # {"Channel" => "Program"...}
-      config[:block_class_for_resource_kind][key] = val # class name (string)
+    private
+    # A caching one-of-each-sort constructor.
+    #
+    # ==== Parameters
+    # * <tt>kind</tt> - Class name (string) of a scheduled resource.
+    # * <tt>rid</tt>  - Id (string), selecting a resource instance.  The two are combined and used as a unique tag in the DOM as id and class attributes as well as in server code.
+    def get_for( kind, rid )
+      tag = compose_tag( kind, rid )
+      # config[:rsrc_of_tag][ tag ] || self.new( kind, rid )
+      rsrc_of_tag[ tag ] || new( kind, rid )
     end
 
-    if (rkls = yml['Resources'])        # Resource Kind Lists, eg
-      rkls.each do |rkl|                # ["TimeheaderHour", "Hour0"]
-        rkl = rkl.split(/[, ]+/)        # ["Channel",    "702", "703",... ]
-        rk  = rkl.shift
-        add_resources rkl.map{ |sub_id| make_resource_of_kind(rk, sub_id) }
+    def add_rubs_of_kind( kind, ru_blkss, blockss )
+      ru_blkss.each do |rid, blks|
+        rsrc = get_for( kind, rid )
+        rubs = blks.map{ |blk| ResourceUseBlock.new rsrc, blk }
+        blockss[ rsrc ] = rubs
       end
     end
 
-    vt = yml['visibleTime']
-    config[:visible_time]   = vt ? (eval vt) : 3.hours
-
-    t0 = yml['timeRangeMin']
-    config[:time_range_min] = t0 ? (eval t0) : (Time.now - 1.week)
-
-    tn = yml['timeRangeMax']
-    config[:time_range_max] = tn ? (eval tn) : (Time.now + 1.week)
-
-    config
-  end
-
-
-  def self.add_resources(rsrcs)
-    rs = config[:all_resources]
-    rsrcs.each{ |rsrc| rs.include?( rsrc ) || rs << rsrc }
-  end
-
-
-  def self.config_from_yaml2( session )
-    config[:rsrcs_by_kind] = resource_list.group_by{ |r| r.kind }
-
-    config[:rsrcs_by_kind].each do |kind, rsrcs|
-      klass = kind.constantize
-      rsrcs.each {|rsrc| klass.decorate_resource rsrc }
-    end
-
-    session[:schedule_config] = config
-  end
-
-  def self.make_resource_of_kind( klass, rid )
-    klass = eval klass if klass.class == String
-    get_for( klass.name, rid )
-  end
-
-  def self.add_rubs_of_kind( kind, ru_blkss, blockss )
-    ru_blkss.each do |rid, blks|
-      rsrc = get_for( kind, rid )
-      rubs = blks.map{ |blk| ResourceUseBlock.new rsrc, blk }
-      blockss[ rsrc ] = rubs
-    end
   end
 
 
   public
 
   # Instance methods
-  def initialize( kind, sub_id ) # :nodoc:
-    @tag = self.class.send( :compose_tag, kind, sub_id )
+  def initialize( kind, rid ) # :nodoc:
+    # @tag = self.class.send( :compose_tag, kind, rid )
+    @tag = self.class.compose_tag( kind, rid )
     @label = @title = nil
-    config[:rsrc_of_tag][@tag] = self
+    self.class.rsrc_of_tag[@tag] = self
   end
 
   # ==== Returns
@@ -247,15 +152,11 @@ class ScheduledResource
     "<#ScheduledResource \"#{@tag}\">"
   end
 
-  attr_accessor :label, :title
+  attr_writer :label, :title
   def label();     @label || @tag end
-
-  def label=(val)
-    @label = val
-  end
-
   def title();     @title || @tag end
 
+
   # ==== Returns
   # * <tt>String</tt> - CSS classes automatically generated for the DOM row representing this SchedResource.
   def css_classes_for_row(); "rsrcRow #{self.kind}row #{@tag}row #{self.kind}Row #{@tag}Row" end # Row + row -- really?

data/lib/scheduled_resource/config.rb

@@ -0,0 +1,115 @@
+class ScheduledResource # Think module 
+
+  # Config is loaded from config/schedule.yml:
+  # ResourceKinds::   A list of string pairs: [ resource class, use_block class ]
+  # Resources::       A list of: [ ResourceKind resource_id... ] 
+  # visibleTime::     Span of time window (seconds).
+  # timeRangeMin::
+  # timeRangeMax::
+
+  # Schedule configuration data itself is fairly brief and generally
+  # can be kept in the session.  An instance of this class (though
+  # reflecting the same information) isn't suitable for session
+  # storage.  It is more useful for processing a request and also
+  # mediates (later) changes to the configuration.
+  class Config
+    
+    attr_reader :visible_time, :time_range_min, :time_range_max
+    attr_reader :resource_list
+
+    # For now we have a single, static configuration...
+    CONFIG_FILE = "config/resource_schedule.yml"
+    #--
+    # Restore configuration from session or base as needed.
+    #
+    # When we depend on data in the configuration to satisfy a query we are not
+    # being RESTful.  On the other hand we are not maintaining changeable state
+    # here -- it's just a cache.  If there <em>were</em> changeable state it
+    # would likely be kept, eg, in a per-user table in the database.
+    #++
+    def self.ensure( session )              # fka ensure_config
+      yml_string = session[:schedule_config]
+      return new( YAML.load(yml_string) ) if yml_string
+
+      from_base( session )
+    end
+
+
+    # ToDo: Generalize this so configuration can be loaded on per-user.
+    def self.from_base( session )           # fka config_from_yaml1
+      yml = YAML.load_file CONFIG_FILE
+      session[:schedule_config] = yml.to_yaml
+      new( yml )
+    end
+
+
+    # (hi-lock-face-buffer "yml\\[.*\\]" 'hi-yellow)
+    # A Hash, as from a yml file.
+    def initialize( yml )                   # fka config_from_yaml
+      @yml = yml
+      @resource_list                 = []   # fka :all_resources
+      @block_class_for_resource_kind = {}
+      
+      yml['ResourceKinds'].each do |key, val| # {"Channel" => "Program"...}
+        @block_class_for_resource_kind[key] = val # class name (string)
+      end
+
+      do_resource_kind_lists( yml['Resources'] || [] )
+
+
+      # Eval is FAR TOO DANGEROUS for user input.  Rather, parse a string
+      # into (number).(unit) (maybe a couple of other patterns) to sanitize.
+      vt = yml['visibleTime']
+      @visible_time   = vt ? (eval vt) : 3.hours
+
+      t0 = yml['timeRangeMin']
+      @time_range_min = t0 ? (eval t0) : (Time.now - 1.week)
+
+      tn = yml['timeRangeMax']
+      @time_range_max = tn ? (eval tn) : (Time.now + 1.week)
+
+
+      rsrcs_by_kind.each do |kind, rsrcs|   # fka config_from_yaml2
+        klass = kind.constantize
+        rsrcs.each {|rsrc| klass.decorate_resource rsrc }
+      end
+    end
+
+
+    # Resource Kind Lists,
+    # Each line (in yml format) is a ResourceKind followed by rids
+    # such as  "Channel   702 703 ..."
+    def do_resource_kind_lists( rkls )
+      rkls.each do |rkl|
+        rkl   = rkl.split(/[, ]+/)   # ["Channel",  "702", "703" ...]
+        rk    = rkl.shift
+        rsrcs = rkl.map{|rid| ScheduledResource.make_resource_of_kind(rk, rid)}
+
+        add_resources rsrcs
+      end
+    end
+
+
+    # Hmm... DOM Row uniqueness vs resource (tag) uniqueness.
+    def add_resources(rsrcs)
+      rsrcs.each do |rsrc| 
+        @resource_list << rsrc unless @resource_list.include? rsrc 
+      end
+    end
+
+    def rsrcs_by_kind
+      @resource_list.group_by{ |r| r.kind }
+    end
+
+    # ==== Parameters
+    # * <tt>name</tt>  - The class name (string) of a schedule resource.
+    #
+    # ==== Returns
+    # * <tt>Class</tt> - The class representing the <em>use</em> of that resource for an interval of time.
+    def block_class_for_resource_name( name )
+      @block_class_for_resource_kind[name].constantize
+    end
+
+  end
+
+end

data/lib/scheduled_resource/helper.rb

@@ -3,9 +3,9 @@ class ScheduledResource
 
   module Helper
 
-    def ensure_schedule_config
-      meth = params[:reset] ? :config_from_yaml : :ensure_config
-      ScheduledResource.send( meth, session )
+    def ensure_schedule_config   # fka :config_from_yaml : :ensure_config
+      meth = params[:reset] ? :from_base : :ensure
+      @config = ScheduledResource::Config.send( meth, session )
     end
 
     def default_time_param
@@ -15,7 +15,7 @@ class ScheduledResource
 
     def set_schedule_query_params(p = params)
       @t1 = p[:t1] || default_time_param
-      @t2 = p[:t2] || @t1 + ScheduledResource.visible_time
+      @t2 = p[:t2] || @t1 + @config.visible_time # ScheduledResource.visible_time
       @inc= p[:inc]
     end
 
@@ -32,19 +32,20 @@ class ScheduledResource
       @t1 = Time.at(@t1.to_i)
       @t2 = Time.at(@t2.to_i)
 
-      @rsrcs = ScheduledResource.resource_list
+      @rsrcs   = @config.resource_list   # ScheduledResource.resource_list
 
-      @blockss = ScheduledResource.get_all_blocks(@t1, @t2, @inc)
+      @blockss = ScheduledResource.get_all_blocks(@config, @t1, @t2, @inc)
 
       json_adjustments
     end
 
-    def min_time;  ScheduledResource.config[:time_range_min].to_i end
-    def max_time;  ScheduledResource.config[:time_range_max].to_i end
+    def min_time;  @config.time_range_min.to_i end # ScheduledResource.config[:time_range_min]
+    def max_time;  @config.time_range_max.to_i end # ScheduledResource.config[:time_range_max]
 
-    # Always send starttime/endtime attributes as Integer values (UTC) -- they are
-    # used to size and place the blocks.  Timezone is configured separately in the
-    # ZTime* classes (config/resource_schedule.yml).
+    # Always send starttime/endtime attributes as Integer values (UTC)
+    # -- they are used to size and place the use_blocks.  Timezone is
+    # configured separately in the ZTime* classes
+    # (config/resource_schedule.yml).
     def json_adjustments
       @blockss.each do |rsrc, blocks|
         blocks.each do |block|
@@ -58,8 +59,6 @@ class ScheduledResource
       }
     end
 
-
-
   end
 
 end

data/lib/scheduled_resource/version.rb

@@ -1,3 +1,3 @@
 class ScheduledResource
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scheduled_resource
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Mike Cannon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-13 00:00:00.000000000 Z
+date: 2015-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -169,6 +169,7 @@ files:
 - lib/assets/javascripts/use_block.js.coffee
 - lib/assets/stylesheets/scheduled_resource.css.scss
 - lib/scheduled_resource.rb
+- lib/scheduled_resource/config.rb
 - lib/scheduled_resource/helper.rb
 - lib/scheduled_resource/resource_use_block.rb
 - lib/scheduled_resource/version.rb
@@ -199,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Display how something is used over time.