concerto_hardware 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78926444b14981b5a897bcbd8662f7d1abb5d2b6
-  data.tar.gz: 7e521966dae2d75ab103e62869eac6019100de01
+  metadata.gz: 7755452c779d4727103fc30b2a4240fab346bcf0
+  data.tar.gz: b4ac85892d72694abe88eb8203230083e479a631
 SHA512:
-  metadata.gz: f13bb763b161fa1cb5c10e662326d1a2261bc7e8369276d642ee9302850e2edb76dbd3ac908848a1b955851a45d37a5bd62f2d53b66da2e7a23330778f51414d
-  data.tar.gz: 115b314f996a2b566da9e0d91605abc70e93f9882f37956632a71a4681100bcffbbf1de3f642bd7a9b85fdea18aa77ca04bef493d94729579c307065124f5c16
+  metadata.gz: 527f89252a3e7aaf88468aa0e606d2cacc40c0690300625277d38b675630f12776d3bdf83941d9df5689976643477e2114d0f2738830a96a717c6b9e2d0bf80f
+  data.tar.gz: c91e1657fb61bcafd689e9eeee934454dce3b028b557672b1517b871711c2208085e187358ece759c0a543bc3d7dff55ac670169dcf007e7fdc3c0201691eb3c

data/app/assets/javascripts/concerto_hardware/application.js

@@ -1,15 +1,18 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
+// This is a manifest file that will compile javascripts used by this plugn's
+// views. This plugin is configured to use the main application's layouts, so
+// it adds to what is available there, and its assets are not meant for
+// standalone use. 
 //
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+// The plugin is added to the application's layout via a hook in enine.rb.
 //
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// the compiled file.
+// We make the assumption that jquery and jquery_ujs have been included
+// by Concerto's application.js before this file is loaded, so we can
+// skip those includes.
 //
-// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
-// GO AFTER THE REQUIRES BELOW.
+// It's not advisable to add code directly here, but if you do, it'll appear
+// at the bottom of the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED,
+// ANY BLANK LINE SHOULD GO AFTER THE REQUIRES BELOW.
 //
-//= require jquery
-//= require jquery_ujs
 //= require_tree .

data/app/assets/javascripts/concerto_hardware/players.js

@@ -1,2 +1,25 @@
 // Place all the behaviors and hooks related to the matching controller here.
-// All this logic will automatically be available in application.js.
+// All this logic will automatically be available in plugin.js
+
+// Namespace the plugin for neatness
+var ConcertoHardware = {
+  updateWkndOnOff: function() {
+    if ($('#player_wknd_disable').is(':checked')) {
+      $('#wknd_on_time_div').hide();
+      $('#wknd_off_time_div').hide();
+    } else {
+      $('#wknd_on_time_div').show();
+      $('#wknd_off_time_div').show();
+    }
+  },
+
+  initPlayers: function() {
+    ConcertoHardware.updateWkndOnOff();
+    $('#player_wknd_disable').change(function() {
+      ConcertoHardware.updateWkndOnOff();
+    });
+  }
+};
+
+$(document).ready(ConcertoHardware.initPlayers);
+$(document).on('page:change', ConcertoHardware.initPlayers);

data/app/controllers/concerto_hardware/application_controller.rb

@@ -7,10 +7,11 @@ module ConcertoHardware
   # Note that links back to the main application will need to directly
   # reference the main_app router.
   class ApplicationController < ::ApplicationController
+    unloadable # Marks this class for reloading in development mode
     def current_ability
       # Use the Ability class defined in this engine's namespace.
       # It is designed to also include the rules from the main app.
-      @current_ability ||= Ability.new(current_accessor)
+      @current_ability ||= ConcertoHardware::Ability.new(current_accessor)
     end
   end
 end

data/app/controllers/concerto_hardware/players_controller.rb

@@ -1,8 +1,5 @@
-require_dependency "concerto_hardware/application_controller"
-
 module ConcertoHardware
-class PlayersController < ApplicationController
-  unloadable #marks this class for reloading in between requests
+class PlayersController < ConcertoHardware::ApplicationController
   #include routes.named_routes.helpers
   before_filter :screen_api
 
@@ -50,45 +47,12 @@ class PlayersController < ApplicationController
     end
   end
 
-  # GET /players/new
-  # GET /players/new.json
-  def new
-    @player = Player.new
-    if !params[:screen_id].nil?
-      # TODO: Error handling
-      @player.screen = Screen.find(params[:screen_id])
-    end
-    auth!
-
-    respond_to do |format|
-      format.html # new.html.erb
-      format.json { render :json => @player }
-    end
-  end
-
   # GET /players/1/edit
   def edit
     @player = Player.find(params[:id])
     auth!
   end
 
-  # POST /players
-  # POST /players.json
-  def create
-    @player = Player.new(player_params)
-    auth!
-
-    respond_to do |format|
-      if @player.save
-        format.html { redirect_to [hardware, @player], :notice => 'Player was successfully created.' }
-        format.json { render :json => @player, :status => :created, :location => @player }
-      else
-        format.html { render :action => "new" }
-        format.json { render :json => @player.errors, :status => :unprocessable_entity }
-      end
-    end
-  end
-
   # PUT /players/1
   # PUT /players/1.json
   def update
@@ -124,7 +88,7 @@ class PlayersController < ApplicationController
   # Deal with strong parameter restrictions.
   def player_params
     params.require(:player).permit(:wkday_on_time, :wkday_off_time,
-      :wknd_on_time, :wkday_off_time, :wknd_disable, :force_off)
+      :wknd_on_time, :wknd_off_time, :wknd_disable, :force_off)
   end
 end
 

data/app/models/concerto_hardware/player.rb

@@ -24,10 +24,28 @@ module ConcertoHardware
     validates_presence_of :screen, :message => 'must exist'
     validates_uniqueness_of :screen_id
 
+    # Time virtual attributes return nil if an invalid attribute
+    # was given.
+    validates :wkday_on_time, :wkday_off_time, :presence => {
+      :message => :must_be_valid_time
+    }
+    validates :wknd_on_time, :wknd_off_time, :presence => {
+      :unless => "wknd_disable?",
+      :message => :must_be_valid_time
+    }
+    validate :on_must_come_before_off
+
     after_initialize :default_values
     after_find :retrieve_screen_on_off
     before_save :process_screen_on_off
 
+    # Evaluates truthiness of the virtual attribute.
+    def wknd_disable?
+      return true if self.wknd_disable == "1"
+      return true if self.wknd_disable == true
+      return false
+    end
+
     def default_values
       self.screen_on_off ||= [
         {
@@ -51,10 +69,15 @@ module ConcertoHardware
     # https://github.com/concerto/concerto-hardware/
     #                            wiki/Player-API#screen-onoff-times
     # TODO: Formatting for datetimes
-    # TODO: Validation
     # TODO: TIMEZONES
     def process_screen_on_off
       ruleset = []
+      if wknd_disable?
+        # Special case: we can ignore invlaid wknd times if we're off
+        # on the weekend (avoids a rough edge on form submission).
+        self.wknd_on_time = "09:00" if wknd_on_time.nil?
+        self.wknd_off_time = "23:00" if wknd_off_time.nil?
+      end
       unless self.wkday_on_time.nil? or self.wkday_off_time.nil?
         ruleset << {
           :action => "on",
@@ -65,7 +88,7 @@ module ConcertoHardware
       end
       unless self.wknd_on_time.nil? or self.wknd_off_time.nil?
         ruleset << {
-          :action => self.wknd_disable=="1" ? "off" : "on",
+          :action => self.wknd_disable? ? "off" : "on",
           :wkday => "06", # Sun, Sat
           :time_after => fmt_time(wknd_on_time),  # "07:00"
           :time_before => fmt_time(wknd_off_time), # "23:00"
@@ -138,7 +161,7 @@ module ConcertoHardware
       else
         rules << "Weekdays: on at "+fmt_time(wkday_on_time, "%l:%M%P")+", "+
           "off at "+fmt_time(wkday_off_time, "%l:%M%P")+"."
-        if wknd_disable
+        if wknd_disable?
           rules << "Weekends: off."
         else
           rules << "Weekends: on at "+fmt_time(wknd_on_time, "%l:%M%P")+", "+
@@ -171,5 +194,22 @@ module ConcertoHardware
       json
     end
 
+    private
+
+    # Time order validation method
+    def on_must_come_before_off
+      unless wkday_off_time.nil? or wkday_on_time.nil?
+        if wkday_off_time < wkday_on_time
+          errors.add :wkday_off_time, :must_come_after,
+            :before => self.class.human_attribute_name(:wkday_on_time)
+        end
+      end
+      unless wknd_off_time.nil? or wknd_on_time.nil? or wknd_disable?
+        if wknd_off_time < wknd_on_time
+          errors.add :wknd_off_time, :must_come_after,
+            :before => self.class.human_attribute_name(:wknd_on_time)
+        end
+      end
+    end
   end # class Player
 end # module ConcertoHardware

data/app/views/concerto_hardware/players/_form.html.erb

@@ -44,14 +44,14 @@
         </ul>
       </div>
     </div>
-    <div class="clearfix">
+    <div class="clearfix" id="wknd_on_time_div">
       <%= f.label :wknd_on_time %>
       <div class="input-prepend">
         <span class="add-on"><%= t(:at) %></span>
         <%= f.text_field(:wknd_on_time, :maxlength => 20, :class => "timefield input-small", :value => @player.fmt_time(@player.wknd_on_time, "%l:%M%P") || ConcertoConfig[:content_default_start_time]) %>
       </div>
     </div>
-    <div class="clearfix">
+    <div class="clearfix" id="wknd_off_time_div">
       <%= f.label :wknd_off_time %>
       <div class="input-prepend">
         <span class="add-on"><%= t(:at) %></span>
@@ -62,11 +62,10 @@
     <div class="clearfix">
       <div class="input checkbox">
         <ul class="inputs-list">
-          <li><%= f.check_box :force_off %> <%= f.label :force_off %> (temporarily turns off the screen until midnight tonight)</li>
+          <li><%= f.check_box :force_off %> <%= f.label :force_off %> (<%= t('.force_off_msg') %>)</li>
         </ul>
       </div>
     </div>
-    <p><em>All time fields should be entered in 24 hour format (HH:mm), for example 23:30 for 11:30 PM.</em></p>
   </fieldset>
 
   <div class="submit_bar actions">

data/app/views/concerto_hardware/players/_show_body.html.erb

@@ -7,14 +7,14 @@
 <p id="notice"><%= notice %></p>
 
 <p>
-  <b>Ip address:</b>
+  <b><%= ConcertoHardware::Player.human_attribute_name(:ip_address) %>:</b>
   <%= @player.ip_address %>
 </p>
 
 <p>
-  <b>Screen:</b>
+  <b><%= ConcertoHardware::Player.human_attribute_name(:screen) %>:</b>
   <% if @player.screen.nil? %>
-    Not found
+    <%= t('.no_screen_found') %>
   <% else %>
     <% if can? :read, @player.screen %>
       <%= link_to @player.screen.name, [main_app, @player.screen] %>
@@ -25,12 +25,12 @@
 </p>
 
 <p>
-  <b>Activated:</b>
+  <b><%= ConcertoHardware::Player.human_attribute_name(:activated) %>:</b>
   <%= @player.activated %>
 </p>
 
 <p>
-  <b>Screen on/off times:</b>
+  <b><%= ConcertoHardware::Player.human_attribute_name(:screen_on_off_times) %>:</b>
   <ul>
     <% @player.describe_screen_on_off.each do |rule| %>
       <li><%=rule%></li>

data/app/views/concerto_hardware/players/index.html.erb

@@ -1,12 +1,5 @@
 <section class="viewblock">
   <header class="viewblock-header">
-    <div class="viewblock-header_right">
-      <div class="button-padding">
-        <% if can? :create, ConcertoHardware::Player %>
-          <%= link_to t(:new_model, :model => ConcertoHardware::Player.model_name.human), new_player_path, :class => "btn" %>
-        <% end %>
-      </div>
-    </div>
     <h1 class="default-padding">
       <%= t(:all_model, :model => ConcertoHardware::Player.model_name.human.pluralize) %>
     </h1>
@@ -46,4 +39,5 @@
 <div class="default-padding">
     <%# for demo purposes: %>
     Note: the poll interval is currently set to <%=ConcertoConfig[:poll_interval]%> seconds.
-</div>
+</div>
+

data/app/views/concerto_hardware/screens/_screen_link.html.erb

@@ -6,7 +6,7 @@
       <div class="viewblock-header_right">
         <div class="button-padding">
           <% if (!@player.nil?) && (can? :update, @player) %>
-            <%= link_to 'Edit Player', hardware.edit_player_path(@player), :class => "btn" %>
+            <%= link_to t('.player_settings'), hardware.edit_player_path(@player), :class => "btn" %>
           <% end %>
         </div>
       </div>
@@ -24,11 +24,16 @@
           </div>
         <% else %>
           <h3><%= @screen.name + " Player" %></h3>
-          <p><b><%= @player.activated ? t('.activated') : t('.not_activated') %></b></p>
+          <p><b><%= @player.activated ? t('.is_activated') : t('.not_activated') %></b></p>
           <br />
           <% if can? :read, @player %>
-            <% if current_user %><p><b>IP Address:</b> <%= @player.ip_address %></p><% end %>
-            <p><b>Screen On/Off Times:</b></p>
+            <% if current_user %>
+              <p>
+                 <b><%= ConcertoHardware::Player.human_attribute_name(:ip_address)%>:</b>
+                 <%= @player.ip_address %>
+              </p>
+            <% end %>
+            <p><b><%= ConcertoHardware::Player.human_attribute_name(:screen_on_off_times)%>:</b></p>
             <ul>
               <% @player.describe_screen_on_off.each do |rule| %>
                 <li><%= rule %></li>

data/config/locales/en.yml

@@ -6,11 +6,17 @@ en:
       concerto_hardware/player:
         activated: 'Active'
         ip_address: 'IP Address'
-        wkday_on_time: 'Weekday turn On time'
-        wkday_off_time: 'Weekday turn Off time'
+        wkday_on_time: 'Weekday turn on time'
+        wkday_off_time: 'Weekday turn off time'
         wknd_disable: 'Disable on weekends'
-        wknd_on_time: 'Weekend turn On time'
-        wknd_off_time: 'Weekend turn Off time'
+        wknd_on_time: 'Weekend turn on time'
+        wknd_off_time: 'Weekend turn off time'
+        screen_on_off_times: "Screen On/Off Times"
+    errors:
+      models:
+        concerto_hardware/player:
+          must_be_valid_time: 'must be a valid time of day'
+          must_come_after: 'must come after %{before}'
 
   concerto_hardware:
     players:
@@ -18,6 +24,13 @@ en:
         header: 'New %{screen} Player'
       edit:
         header: 'Edit %{screen} Player'
+      form:
+        provide_details: "Provide Details"
+        force_off_msg: "temporarily turns off the screen until midnight tonight"
+      show_body:
+        no_screen_found: "No Screen Found"
+      is_activated: "Activated"
+      not_activated: "Not Activated"
 
     screens:
       screen_link:
@@ -25,5 +38,6 @@ en:
         no_player_header: "No Player"
         no_player_msg: "A Concerto Player has not yet been connected to this screen."
         add_player_msg: "Specify a Player manually."
-        activated: "Activated"
-        not_activated: "Not Activated"
+        player_settings: "Player Settings"
+        is_activated: "Activated"
+        not_activated: "Not Activated"

data/config/routes.rb

@@ -10,7 +10,7 @@ ConcertoHardware::Engine.routes.draw do
 
   # Since we have an isolated namespace, routes are automaticaly scoped
   # to the ConcertoHardware module.
-  resources :players do
+  resources :players, :except => [:new, :create] do
     collection do
       # Look up a player based on the screen ID.
       get 'by_screen/:screen_id' => ConcertoHardware::PlayersController.action(:show)

data/lib/concerto_hardware/engine.rb

@@ -32,6 +32,10 @@ module ConcertoHardware
         # The following hooks allow integration into the main Concerto app
         # at the controller and view levels.
 
+        add_header_tags do
+          javascript_include_tag "concerto_hardware/application"
+        end
+
         add_controller_hook "ScreensController", :show, :before do
           @player = Player.find_by_screen_id(@screen.id)
         end

data/lib/concerto_hardware/time_accessible.rb

@@ -31,18 +31,22 @@ module ConcertoHardware
        self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{sym}
             if @#{sym}_timeobj.is_a? Time
-              @#{sym}_timeobj.to_s
+              @#{sym}_timeobj
             else
               nil
             end
           end
           def #{sym}=(val)
+            @#{sym}_timeobj = nil
             if val.is_a? Time
               @#{sym}_timeobj = val
             elsif val.is_a? String
-              @#{sym}_timeobj = Time.parse(val)
-            else
-              raise ArgumentError.new("Only Strings or Times allowed")
+              begin
+                @#{sym}_timeobj = Time.parse(val)
+              rescue ArgumentError => e
+                # Example: empty string or not a time
+                # Value gets nil, which validations will flag.
+              end
             end
           end
         RUBY

data/lib/concerto_hardware/version.rb

@@ -1,3 +1,3 @@
 module ConcertoHardware
-  VERSION = "0.2"
+  VERSION = "0.3"
 end

data/lib/concerto_hardware.rb

@@ -1,4 +1,5 @@
 require "concerto_hardware/engine"
+require "concerto_hardware/time_accessible"
 
 module ConcertoHardware
   # There is no important functionality at the module level.

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: concerto_hardware
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Concerto Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-01 00:00:00.000000000 Z
+date: 2015-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A Rails Engine for managing Bandshell-powered Concerto hardware
@@ -31,6 +31,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.rdoc
+- Rakefile
 - app/assets/images/concerto_hardware/helpicon.png
 - app/assets/javascripts/concerto_hardware/application.js
 - app/assets/javascripts/concerto_hardware/players.js
@@ -54,13 +57,10 @@ files:
 - config/routes.rb
 - db/migrate/20121220000000_create_concerto_hardware_players.rb
 - db/migrate/20131127201048_add_updates_to_concerto_hardware_players.rb
+- lib/concerto_hardware.rb
 - lib/concerto_hardware/engine.rb
 - lib/concerto_hardware/time_accessible.rb
 - lib/concerto_hardware/version.rb
-- lib/concerto_hardware.rb
-- LICENSE
-- Rakefile
-- README.rdoc
 - test/fixtures/players.yml
 - test/functional/players_controller_test.rb
 - test/unit/helpers/players_helper_test.rb
@@ -75,17 +75,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A Rails Engine for managing Bandshell-powered Concerto hardware