bit_player 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1e21e39e222450b6deb3c43040e74ee125fff5d
-  data.tar.gz: caa9274f55cef000e2b711fa7138882afe724b6a
+  metadata.gz: 35768c8e530397c5ff3197cdc50628a902056616
+  data.tar.gz: 493cf2180856d1cdfa73cb7ccb04f9cbdc532846
 SHA512:
-  metadata.gz: b232fa67a975f82361a4c4ae5e2ad1310ce82c3ae7b708d13b190675ed59c8761c939bf762e56a03e2863f01a32ab3c9d8d24bdc2813b8b08bb7bad5768dc81e
-  data.tar.gz: b00ff8f09a9cd0f07e8e8cea184ff124695738d46bddcc3fca176be8875e70e62dd59578cb171f3930b333918fb2561bea07c895cead9555adacf1f6b1ebd0e7
+  metadata.gz: e3b3909f4daa68f27a38a7253931dd13f6ec4d3513b030a5ca513f83d2a0990420af15c0b9dba3904dc5d1dfc1fd5e2829dcadb2462667f4b1fb9e88ae55e6ca
+  data.tar.gz: 076f6f351e4f597ba668b53cb55969efec36c9cf9a9d3e17ed6fbb52a8e31a0b368cb3ae1cfa3e6a8a6fe555fcadc490a1cb9c2dc62d5511a7d27af910de8083

data/README.md

@@ -5,3 +5,7 @@
 ## Installation
 
     gem install bit-player
+
+## Run tests
+
+    rake test

data/Rakefile

@@ -18,8 +18,11 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
+task :test do
+  puts `cd spec/dummy; RAILS_ENV=test rake db:drop db:create db:migrate; cd ../..; rspec`
+end
 
 Bundler::GemHelper.install_tasks
 

data/app/models/bit_player/content_module.rb

@@ -1,17 +1,18 @@
 module BitPlayer
+  # A logical unit of content, possibly containing mixed provider types.
   class ContentModule < ActiveRecord::Base
     has_many :content_providers,
-      class_name: "BitPlayer::ContentProvider",
-      foreign_key: :bit_player_content_module_id,
-      inverse_of: :content_module
+             class_name: "BitPlayer::ContentProvider",
+             foreign_key: :bit_player_content_module_id,
+             inverse_of: :content_module
 
     validates :title, :context, :position, presence: true
-    validates_numericality_of :position, greater_than_or_equal_to: 1
-    validates_uniqueness_of :position, scope: :context
+    validates :position, numericality: { greater_than_or_equal_to: 1 }
+    validates :position, uniqueness: { scope: :context }
 
     def provider(position)
       content_providers.where(position: position).first ||
-        BitPlayer::ContentProviders::Null.new(self)
+        BitPlayer::ContentProviders::Null.new(self, position)
     end
 
     def provider_exists?(position)

data/app/models/bit_player/content_provider.rb

@@ -1,15 +1,16 @@
 module BitPlayer
+  # Modeled after the presenter pattern. Ties data layer to view layer.
   class ContentProvider < ActiveRecord::Base
     include BitPlayer::ContentProviders::ViewProvider
 
     belongs_to :content_module,
-      class_name: "BitPlayer::ContentModule",
-      foreign_key: :bit_player_content_module_id,
-      inverse_of: :content_providers
+               class_name: "BitPlayer::ContentModule",
+               foreign_key: :bit_player_content_module_id,
+               inverse_of: :content_providers
     belongs_to :source_content, polymorphic: true
 
     validates :content_module, :position, presence: true
-    validates_numericality_of :position, greater_than_or_equal_to: 1
+    validates :position, numericality: { greater_than_or_equal_to: 1 }
 
     delegate :context, to: :content_module, prefix: false
 

data/app/models/bit_player/content_providers/form_view_provider.rb

@@ -1,13 +1,19 @@
+require "active_support/concern"
+
 module BitPlayer
-  module ContentProviders::FormViewProvider
-    def self.included(base)
-      base.class_eval do
+  module ContentProviders
+    # Presentation logic for a "new" or "edit" view on a data model.
+    module FormViewProvider
+      extend ActiveSupport::Concern
+
+      included do
         def self.data_class(klass)
           @source_class = klass
         end
 
         def self.source_class
-          @source_class || fail("Classes inheriting from #{ self } must define a source class with `data_class <class>`")
+          @source_class || fail("Classes inheriting from #{ self } must define
+                                a source classwith `data_class <class>`")
         end
 
         def self.show_nav_link
@@ -33,20 +39,20 @@ module BitPlayer
           @view_type
         end
       end
-    end
 
-    def show_nav_link?
-      self.class.show_nav_link?
-    end
+      def show_nav_link?
+        self.class.show_nav_link?
+      end
 
-    def template
-      "#{ plural_name }/#{ self.class.get_view_type }"
-    end
+      def template
+        "#{ plural_name }/#{ self.class.get_view_type }"
+      end
 
-    private
+      private
 
-    def plural_name
-      self.class.source_class.to_s.underscore.pluralize
+      def plural_name
+        self.class.source_class.to_s.underscore.pluralize
+      end
     end
   end
 end

data/app/models/bit_player/content_providers/null.rb

@@ -1,15 +1,22 @@
 module BitPlayer
-  class ContentProviders::Null
-    def initialize(content_module)
-      @content_module = content_module
-    end
+  module ContentProviders
+    # The default provider.
+    class Null
+      attr_reader :position
 
-    def render_current(options)
-      "Content Module #{ @content_module.title }: Oops, did you expect a content provider here?"
-    end
+      def initialize(content_module, position)
+        @content_module = content_module
+        @position = position
+      end
+
+      def render_current(options)
+        "Content Module #{ @content_module.title }: Oops, did you expect a
+        content provider here?"
+      end
 
-    def show_nav_link?
-      true
+      def show_nav_link?
+        true
+      end
     end
   end
 end

data/app/models/bit_player/content_providers/slideshow_provider.rb

@@ -1,28 +1,32 @@
 module BitPlayer
-  class ContentProviders::SlideshowProvider < ContentProvider
-    def slideshow
-      source_content
-    end
+  module ContentProviders
+    # Defines presentation logic for a Slideshow.
+    class SlideshowProvider < ContentProvider
+      def slideshow
+        source_content
+      end
 
-    def render_current(options)
-      options.view_context.render(
-        template: "slides/show",
-        locals: {
-          slide: slide(options.position)
-        }
-      )
-    end
+      def render_current(options)
+        options.view_context.render(
+          template: "slides/show",
+          locals: {
+            slide: slide(options.position)
+          }
+        )
+      end
 
-    def slide(position)
-      slideshow.slides.where(position: position).first || BitPlayer::Slide.new(body: "no slides")
-    end
+      def slide(position)
+        slideshow.slides.where(position: position).first ||
+          BitPlayer::Slide.new(body: "no slides")
+      end
 
-    def exists?(position)
-      slideshow.slides.exists?(position: position)
-    end
+      def exists?(position)
+        slideshow.slides.exists?(position: position)
+      end
 
-    def show_nav_link?
-      true
+      def show_nav_link?
+        true
+      end
     end
   end
 end

data/app/models/bit_player/content_providers/view_provider.rb

@@ -1,13 +1,19 @@
+require "active_support/concern"
+
 module BitPlayer
-  module ContentProviders::ViewProvider
-    def self.included(base)
-      base.class_eval do
+  module ContentProviders
+    # Presentation logic for a "show" or "index" view on a data model.
+    module ViewProvider
+      extend ActiveSupport::Concern
+
+      included do
         def self.data_class(klass)
           @source_class = klass
         end
 
         def self.source_class
-          @source_class || fail("Classes inheriting from #{ self } must define a source class with `data_class <class>`")
+          @source_class || fail("Classes inheriting from #{ self } must define
+                                a source class with `data_class <class>`")
         end
 
         def self.show_nav_link
@@ -33,20 +39,20 @@ module BitPlayer
           @view_type
         end
       end
-    end
 
-    def show_nav_link?
-      self.class.show_nav_link?
-    end
+      def show_nav_link?
+        self.class.show_nav_link?
+      end
 
-    def template
-      "#{ plural_name }/#{ self.class.get_view_type }"
-    end
+      def template
+        "#{ plural_name }/#{ self.class.get_view_type }"
+      end
 
-    private
+      private
 
-    def plural_name
-      self.class.source_class.to_s.underscore.pluralize
+      def plural_name
+        self.class.source_class.to_s.underscore.pluralize
+      end
     end
   end
 end

data/app/models/bit_player/navigator.rb

@@ -1,6 +1,9 @@
 module BitPlayer
+  # Business rules for proceeding statefully through an application.
   class Navigator
-    RenderOptions = Struct.new(:view_context, :app_context, :position, :participant)
+    RenderOptions = Struct.new(
+      :view_context, :app_context, :position, :participant
+    )
 
     def initialize(participant)
       @participant = participant
@@ -24,7 +27,9 @@ module BitPlayer
     end
 
     def render_current_content(view_context)
-      options = RenderOptions.new(view_context, context, content_position, @participant)
+      options = RenderOptions.new(
+        view_context, context, content_position, @participant
+      )
 
       current_content_provider.render_current(options)
     end
@@ -55,10 +60,10 @@ module BitPlayer
       content_module = ContentModule.find(options[:module_id])
       @status.context = content_module.context
       @status.module_position = content_module.position
+      @status.provider_position = 1
       if options[:provider_id]
-        @status.provider_position = content_module.content_providers.find(options[:provider_id]).position
-      else
-        @status.provider_position = 1
+        @status.provider_position = content_module.content_providers
+          .find(options[:provider_id]).position
       end
       @status.content_position = [options[:content_position].to_i, 1].max
       @status.save

data/app/models/bit_player/participant_status.rb

@@ -1,27 +1,26 @@
 module BitPlayer
+  # Persistent data representing the Participant's navigation state.
   class ParticipantStatus < ActiveRecord::Base
     belongs_to :participant
 
     def initialize_context(name)
-      self.context = name
-      self.module_position = 1
-      self.provider_position = 1
-      self.content_position = 1
-
-      save
+      update(
+        context: name,
+        module_position: 1,
+        provider_position: 1,
+        content_position: 1
+      )
     end
 
     def increment_content_position
-      self.content_position += 1
-
-      save
+      update(content_position: content_position + 1)
     end
 
     def increment_provider_position
-      self.provider_position += 1
-      self.content_position = 1
-
-      save
+      update(
+        provider_position: provider_position + 1,
+        content_position: 1
+      )
     end
   end
 end

data/app/models/bit_player/slide.rb

@@ -1,40 +1,36 @@
 require "redcarpet"
 
 module BitPlayer
+  # A page of "static" or presentational content (as opposed to data capture).
   class Slide < ActiveRecord::Base
     belongs_to :slideshow,
-      class_name: "BitPlayer::Slideshow",
-      foreign_key: :bit_player_slideshow_id,
-      inverse_of: :slides
+               class_name: "BitPlayer::Slideshow",
+               foreign_key: :bit_player_slideshow_id,
+               inverse_of: :slides
 
     validates :title, :body, :position, presence: true
-    validates_numericality_of :position, greater_than_or_equal_to: 1
-    validates_uniqueness_of :position, scope: :bit_player_slideshow_id
-
-    def render_body
-      rendered = ""
-
-      if !body.nil?
-        markdown = Redcarpet::Markdown.new(
-          Redcarpet::Render::HTML.new(
-            filter_html: true,
-            safe_links_only: true
-          ),
-          space_after_headers: true,
-        )
-        rendered += markdown.render(body)
-      end
-
-      rendered.html_safe
-    end
+    validates :position, numericality: { greater_than_or_equal_to: 1 }
+    validates :position, uniqueness: { scope: :bit_player_slideshow_id }
 
     def self.update_positions(ids)
       transaction do
-        connection.execute "SET CONSTRAINTS slide_position DEFERRED"
+        connection.execute "SET CONSTRAINTS bit_player_slide_position DEFERRED"
         ids.each_with_index do |id, index|
           where(id: id).update_all(position: index + 1)
         end
       end
     end
+
+    def render_body
+      return "" if body.nil?
+
+      Redcarpet::Markdown.new(
+        Redcarpet::Render::HTML.new(
+          filter_html: true,
+          safe_links_only: true
+        ),
+        space_after_headers: true
+      ).render(body).html_safe
+    end
   end
 end

data/app/models/bit_player/slideshow.rb

@@ -1,11 +1,12 @@
 module BitPlayer
+  # A collection of ordered Slides.
   class Slideshow < ActiveRecord::Base
     has_many :slides,
-      -> { order "position" },
-      class_name: "BitPlayer::Slide",
-      foreign_key: :bit_player_slideshow_id,
-      dependent: :destroy,
-      inverse_of: :slideshow
+             -> { order "position" },
+             class_name: "BitPlayer::Slide",
+             foreign_key: :bit_player_slideshow_id,
+             dependent: :destroy,
+             inverse_of: :slideshow
     has_one :content_provider, as: :source_content, inverse_of: :source_content
 
     validates :title, presence: true

data/app/models/bit_player/video_slide.rb

@@ -1,4 +1,5 @@
 module BitPlayer
+  # A Slide with video content.
   class VideoSlide < Slide
     serialize :options
   end

data/db/migrate/20140305234327_create_bit_player_slides.rb

@@ -12,8 +12,6 @@ class CreateBitPlayerSlides < ActiveRecord::Migration
       t.timestamps
     end
 
-    add_index :bit_player_slides, [:position, :bit_player_slideshow_id]
-
     reversible do |dir|
       dir.up do
         execute <<-SQL
@@ -27,7 +25,7 @@ class CreateBitPlayerSlides < ActiveRecord::Migration
         # updated
         execute <<-SQL
           ALTER TABLE bit_player_slides
-            ADD CONSTRAINT slide_position UNIQUE (bit_player_slideshow_id, position)
+            ADD CONSTRAINT bit_player_slide_position UNIQUE (bit_player_slideshow_id, position)
             DEFERRABLE INITIALLY IMMEDIATE
         SQL
       end
@@ -40,7 +38,7 @@ class CreateBitPlayerSlides < ActiveRecord::Migration
 
         execute <<-SQL
           ALTER TABLE bit_player_slides
-            DROP CONSTRAINT IF EXISTS slide_position
+            DROP CONSTRAINT IF EXISTS bit_player_slide_position
         SQL
       end
     end

data/lib/bit_player/version.rb

@@ -1,3 +1,3 @@
 module BitPlayer
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/dummy/db/migrate/20140306000537_create_bit_player_slides.bit_player.rb

@@ -13,8 +13,6 @@ class CreateBitPlayerSlides < ActiveRecord::Migration
       t.timestamps
     end
 
-    add_index :bit_player_slides, [:position, :bit_player_slideshow_id]
-
     reversible do |dir|
       dir.up do
         execute <<-SQL
@@ -28,7 +26,7 @@ class CreateBitPlayerSlides < ActiveRecord::Migration
         # updated
         execute <<-SQL
           ALTER TABLE bit_player_slides
-            ADD CONSTRAINT slide_position UNIQUE (bit_player_slideshow_id, position)
+            ADD CONSTRAINT bit_player_slide_position UNIQUE (bit_player_slideshow_id, position)
             DEFERRABLE INITIALLY IMMEDIATE
         SQL
       end
@@ -41,7 +39,7 @@ class CreateBitPlayerSlides < ActiveRecord::Migration
 
         execute <<-SQL
           ALTER TABLE bit_player_slides
-            DROP CONSTRAINT IF EXISTS slide_position
+            DROP CONSTRAINT IF EXISTS bit_player_slide_position
         SQL
       end
     end

data/spec/dummy/db/schema.rb

@@ -60,9 +60,8 @@ ActiveRecord::Schema.define(version: 20140306000537) do
     t.datetime "updated_at"
   end
 
-  add_index "bit_player_slides", ["bit_player_slideshow_id", "position"], name: "slide_position", unique: true, using: :btree
+  add_index "bit_player_slides", ["bit_player_slideshow_id", "position"], name: "bit_player_slide_position", unique: true, using: :btree
   add_index "bit_player_slides", ["bit_player_slideshow_id"], name: "index_bit_player_slides_on_bit_player_slideshow_id", using: :btree
-  add_index "bit_player_slides", ["position", "bit_player_slideshow_id"], name: "index_bit_player_slides_on_position_and_bit_player_slideshow_id", using: :btree
 
   create_table "bit_player_slideshows", force: true do |t|
     t.string   "title",      null: false