acts_as_dashboard 0.1.0

data/spec/acts_as_dashboard/short_messages_widget_spec.rb

@@ -0,0 +1,69 @@
+require File.join File.dirname(__FILE__), '..', 'spec_helper'
+require File.join File.dirname(__FILE__), '..', 'shared', 'widget_behaviours'
+
+describe ActsAsDashboard::ShortMessagesWidget do
+  it_should_behave_like 'an ActsAsDashboard Widget'
+
+  describe 'initialization' do # {{{
+    before :each do
+      @options = {
+        :max_data_items => 5
+      }
+    end
+
+    it 'removes the :type element from the given options' do
+      options = {:type => :something}
+      options.should_receive(:delete).with :type
+
+      widget = ActsAsDashboard::ShortMessagesWidget.new options
+    end
+
+    it 'sets its type to :short_messages' do
+      widget = ActsAsDashboard::ShortMessagesWidget.new
+      widget.type.should equal :short_messages
+    end
+
+    it 'sets its max_data_items to the given value' do
+      widget = ActsAsDashboard::ShortMessagesWidget.new :max_data_items => @options[:max_data_items]
+      widget.instance_variable_get(:@max_data_items).should equal 5
+    end
+  end # }}}
+
+  describe 'setting its "max_data_items" attribute' do # {{{
+    it 'raises an error when given an invalid argument' do
+      Proc.new {ActsAsDashboard::ShortMessagesWidget.new.max_data_items = 'fail'}.should raise_error ArgumentError,
+        'The "max_data_items" argument must be a Fixnum.'
+    end
+
+    it 'is successful when given a Fixnum' do
+      w                 = ActsAsDashboard::ShortMessagesWidget.new
+      w.max_data_items  = 5
+
+      w.instance_variable_get(:@max_data_items).should equal 5
+    end
+  end # }}}
+
+  describe 'attributes' do # {{{
+    before :each do
+      @options = {
+        :name             => :some_counter,
+        :title            => 'Some Counter',
+        :block            => Proc.new {123},
+        :update_interval  => '10s',
+        :max_data_items   => 5,
+      }
+
+      @widget = ActsAsDashboard::ShortMessagesWidget.new @options
+    end
+
+    it 'are returned in a Hash' do
+      @options.delete :block    # Remove the "block" key because AAD::Widget#attributes doesn't return it on purpose.
+
+      @widget.attributes.should == @options.merge(:type => :short_messages)
+    end
+
+    it 'returns the "max_data_items" attribute' do
+      @widget.max_data_items.should equal @options[:max_data_items]
+    end
+  end # }}}
+end

data/spec/acts_as_dashboard/widget_spec.rb

@@ -0,0 +1,6 @@
+require File.join File.dirname(__FILE__), '..', 'spec_helper'
+require File.join File.dirname(__FILE__), '..', 'shared', 'widget_behaviours'
+
+describe ActsAsDashboard::Widget do
+  it_should_behave_like 'an ActsAsDashboard Widget'
+end

data/spec/acts_as_dashboard_spec.rb

@@ -0,0 +1,15 @@
+require File.join File.dirname(__FILE__), 'spec_helper'
+
+describe ActsAsDashboard do
+  before :each do
+    class FoosController < ActionController::Base; end
+  end
+
+  it 'includes itself into classes that inherit from ActionController::Base' do
+    FoosController.included_modules.should include ActsAsDashboard
+  end
+
+  it 'extends ActsAsDashboard::ClassMethods into classes that include it' do
+    FoosController.extended_by.should include ActsAsDashboard::ClassMethods
+  end
+end

data/spec/shared/widget_behaviours.rb

@@ -0,0 +1,171 @@
+require File.join File.dirname(__FILE__), '..', 'spec_helper'
+
+module WidgetBehaviours
+  module ExampleGroupMethods
+    shared_examples_for 'an ActsAsDashboard Widget' do # {{{
+      before :each do
+        @options = {
+          :type             => :number,
+          :name             => :some_counter,
+          :title            => 'Some Counter',
+          :block            => Proc.new {123},
+          :update_interval  => '10s',
+        }
+      end
+
+      describe 'initialization' do # {{{
+        it 'accepts no args' do
+          Proc.new {ActsAsDashboard::Widget.new}.should_not raise_error
+        end
+
+        it 'sets its "type" attribute' do
+          w = ActsAsDashboard::Widget.new :type => @options[:type]
+          w.instance_variable_get(:@type).should equal @options[:type]
+        end
+
+        it 'sets its "name" attribute' do
+          w = ActsAsDashboard::Widget.new :name => @options[:name]
+          w.instance_variable_get(:@name).should equal @options[:name]
+        end
+
+        it 'sets its "title" attribute' do
+          w = ActsAsDashboard::Widget.new :title => @options[:title]
+          w.instance_variable_get(:@title).should == @options[:title]
+        end
+
+        it 'sets its "block" attribute' do
+          w = ActsAsDashboard::Widget.new :block => @options[:block]
+          w.instance_variable_get(:@block).should equal @options[:block]
+        end
+
+        it 'sets its "update_interval" attribute to a String' do
+          w = ActsAsDashboard::Widget.new :update_interval => '10s'
+          w.instance_variable_get(:@update_interval).should == '10s'
+        end
+
+        it 'sets its "update_interval" attribute to a Fixnum' do
+          w = ActsAsDashboard::Widget.new :update_interval => 123
+          w.instance_variable_get(:@update_interval).should equal 123
+        end
+      end # }}}
+
+      describe 'setting its "type" attribute' do # {{{
+        it 'is successful when given a Symbol' do
+          w       = ActsAsDashboard::Widget.new
+          w.type  = @options[:type]
+
+          w.instance_variable_get(:@type).should equal @options[:type]
+        end
+
+        it 'raises an exception if given an invalid value' do
+          Proc.new {ActsAsDashboard::Widget.new.type = 'fail'}.should raise_error ArgumentError,
+            'The "type" argument must be a Symbol.'
+        end
+      end # }}}
+
+      describe 'setting its "name" attribute' do # {{{
+        it 'is successful when given a Symbol' do
+          w       = ActsAsDashboard::Widget.new
+          w.name  = @options[:name]
+
+          w.instance_variable_get(:@name).should equal @options[:name]
+        end
+
+        it 'raises an exception if given an invalid value' do
+          Proc.new {ActsAsDashboard::Widget.new.name = 'fail'}.should raise_error ArgumentError,
+            'The "name" argument must be a Symbol.'
+        end
+      end # }}}
+
+      describe 'setting its "title" attribute' do # {{{
+        it 'is successful when given a String' do
+          w       = ActsAsDashboard::Widget.new
+          w.title = @options[:title]
+
+          w.instance_variable_get(:@title).should == @options[:title]
+        end
+
+        it 'raises an exception if given an invalid value' do
+          Proc.new {ActsAsDashboard::Widget.new.title = 123}.should raise_error ArgumentError,
+            'The "title" argument must be a String.'
+        end
+      end # }}}
+
+      describe 'setting its "block" attribute' do # {{{
+        it 'is successful when given a Proc' do
+          w       = ActsAsDashboard::Widget.new
+          w.block = @options[:block]
+
+          w.instance_variable_get(:@block).should equal @options[:block]
+        end
+
+        it 'raises an exception if given an invalid value' do
+          Proc.new {ActsAsDashboard::Widget.new.block = 'fail'}.should raise_error ArgumentError,
+            'The "block" argument must be a Proc.'
+        end
+
+        it 'can be passed as a block' do
+          w = ActsAsDashboard::Widget.new
+
+          w.instance_variable_get(:@block).should be_nil
+          w.data do; end
+
+          w.instance_variable_get(:@block).should be_a Proc
+        end
+      end # }}}
+
+      describe 'setting its "update_interval" attribute' do # {{{
+        it 'is successful when given a String' do
+          w                 = ActsAsDashboard::Widget.new
+          w.update_interval = '10s'
+
+          w.instance_variable_get(:@update_interval).should == '10s'
+        end
+
+        it 'is successful when given a Fixnum' do
+          w                 = ActsAsDashboard::Widget.new
+          w.update_interval = 123
+
+          w.instance_variable_get(:@update_interval).should equal 123
+        end
+
+        it 'raises an exception if given an invalid value' do
+          Proc.new {ActsAsDashboard::Widget.new.update_interval = :fail}.should raise_error ArgumentError,
+            'The "update_interval" argument must be a Fixnum or String.'
+        end
+      end # }}}
+
+      describe 'attributes' do # {{{
+        before :each do
+          @widget = ActsAsDashboard::Widget.new @options
+        end
+
+        it 'are returned in a Hash' do
+          @options.delete :block    # Remove the "block" key because AAD::Widget#attributes doesn't return it on purpose.
+
+          @widget.attributes.should == @options
+        end
+
+        it 'returns the "type" attribute' do
+          @widget.type.should equal @options[:type]
+        end
+
+        it 'returns the "name" attribute' do
+          @widget.name.should equal @options[:name]
+        end
+
+        it 'returns the "title" attribute' do
+          @widget.title.should == @options[:title]
+        end
+
+        it 'returns the "block" attribute' do
+          @widget.block.should equal @options[:block]
+        end
+
+        it 'returns the "update_interval" attribute' do
+          @widget.update_interval.should == @options[:update_interval]
+        end
+      end # }}}
+    end # }}}
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+# Require the Rails application's spec_helper.
+require File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'spec', 'spec_helper')
+
+Spec::Runner.configure do |config|
+end
+
+require 'acts_as_dashboard'

data/tasks/install.rake

@@ -0,0 +1,8 @@
+require File.join File.dirname(__FILE__), '*.rake'
+
+namespace :dashboard do
+  desc 'Install all of the necessary acts_as_dashboard files into a Rails app.'
+  task :install do
+    puts '*** Not implemented yet'
+  end
+end

data/tasks/install_javascript.rake

@@ -0,0 +1,7 @@
+namespace :dashboard do
+  desc 'Install the acts_as_dashboard JavaScript script into RAILS_ROOT/public/javascripts/'
+  task :install_javascript do
+    puts '*** Not implemented yet'
+  end
+end
+

data/tasks/install_stylesheets.rake

@@ -0,0 +1,7 @@
+namespace :dashboard do
+  desc 'Install the acts_as_dashboard CSS files into RAILS_ROOT/public/stylesheets/'
+  task :install_stylesheets do
+    puts '*** Not implemented yet'
+  end
+end
+

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_dashboard
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nick Hoffman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-01 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 2
+        version: 1.3.2
+  type: :development
+  version_requirements: *id002
+description: ActsAsDashboard makes it easy to create dashboards in Rails apps. Very little configuration is required. Read the docs to get started.
+email: nick@deadorange.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- acts_as_dashboard.gemspec
+- generators/dashboard/USAGE
+- generators/dashboard/dashboard_generator.rb
+- generators/dashboard/templates/controller.erb
+- generators/dashboard/templates/dashboard.css
+- generators/dashboard/templates/dashboard.js
+- generators/dashboard/templates/jqplot-0.9.7/jquery.jqplot.min.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.barRenderer.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.barRenderer.min.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.canvasAxisLabelRenderer.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.canvasAxisLabelRenderer.min.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.canvasAxisTickRenderer.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.canvasAxisTickRenderer.min.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.canvasTextRenderer.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.canvasTextRenderer.min.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.categoryAxisRenderer.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.categoryAxisRenderer.min.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.cursor.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.cursor.min.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.dateAxisRenderer.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.dateAxisRenderer.min.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.dragable.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.dragable.min.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.highlighter.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.highlighter.min.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.logAxisRenderer.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.logAxisRenderer.min.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.mekkoAxisRenderer.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.mekkoAxisRenderer.min.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.mekkoRenderer.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.mekkoRenderer.min.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.ohlcRenderer.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.ohlcRenderer.min.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.pieRenderer.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.pieRenderer.min.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.pointLabels.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.pointLabels.js.orig
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.pointLabels.min.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.trendline.js
+- generators/dashboard/templates/jqplot-0.9.7/plugins/jqplot.trendline.min.js
+- generators/dashboard/templates/jquery.jqplot.min.css
+- generators/dashboard/templates/js.class-2.1.4/CHANGELOG
+- generators/dashboard/templates/js.class-2.1.4/MIT-LICENSE
+- generators/dashboard/templates/js.class-2.1.4/README
+- generators/dashboard/templates/js.class-2.1.4/min/command.js
+- generators/dashboard/templates/js.class-2.1.4/min/comparable.js
+- generators/dashboard/templates/js.class-2.1.4/min/constant_scope.js
+- generators/dashboard/templates/js.class-2.1.4/min/core.js
+- generators/dashboard/templates/js.class-2.1.4/min/decorator.js
+- generators/dashboard/templates/js.class-2.1.4/min/enumerable.js
+- generators/dashboard/templates/js.class-2.1.4/min/forwardable.js
+- generators/dashboard/templates/js.class-2.1.4/min/hash.js
+- generators/dashboard/templates/js.class-2.1.4/min/linked_list.js
+- generators/dashboard/templates/js.class-2.1.4/min/loader.js
+- generators/dashboard/templates/js.class-2.1.4/min/method_chain.js
+- generators/dashboard/templates/js.class-2.1.4/min/observable.js
+- generators/dashboard/templates/js.class-2.1.4/min/package.js
+- generators/dashboard/templates/js.class-2.1.4/min/proxy.js
+- generators/dashboard/templates/js.class-2.1.4/min/ruby.js
+- generators/dashboard/templates/js.class-2.1.4/min/set.js
+- generators/dashboard/templates/js.class-2.1.4/min/stack_trace.js
+- generators/dashboard/templates/js.class-2.1.4/min/state.js
+- generators/dashboard/templates/js.class-2.1.4/min/stdlib.js
+- generators/dashboard/templates/js.class-2.1.4/src/command.js
+- generators/dashboard/templates/js.class-2.1.4/src/comparable.js
+- generators/dashboard/templates/js.class-2.1.4/src/constant_scope.js
+- generators/dashboard/templates/js.class-2.1.4/src/core.js
+- generators/dashboard/templates/js.class-2.1.4/src/decorator.js
+- generators/dashboard/templates/js.class-2.1.4/src/enumerable.js
+- generators/dashboard/templates/js.class-2.1.4/src/forwardable.js
+- generators/dashboard/templates/js.class-2.1.4/src/hash.js
+- generators/dashboard/templates/js.class-2.1.4/src/linked_list.js
+- generators/dashboard/templates/js.class-2.1.4/src/loader.js
+- generators/dashboard/templates/js.class-2.1.4/src/method_chain.js
+- generators/dashboard/templates/js.class-2.1.4/src/observable.js
+- generators/dashboard/templates/js.class-2.1.4/src/package.js
+- generators/dashboard/templates/js.class-2.1.4/src/proxy.js
+- generators/dashboard/templates/js.class-2.1.4/src/ruby.js
+- generators/dashboard/templates/js.class-2.1.4/src/set.js
+- generators/dashboard/templates/js.class-2.1.4/src/stack_trace.js
+- generators/dashboard/templates/js.class-2.1.4/src/state.js
+- generators/dashboard/templates/js.class-2.1.4/src/stdlib.js
+- generators/dashboard/templates/show.html.erb
+- lib/acts_as_dashboard.rb
+- lib/acts_as_dashboard/app/views/dashboards/show.html.erb
+- lib/acts_as_dashboard/class_methods.rb
+- lib/acts_as_dashboard/config.rb
+- lib/acts_as_dashboard/instance_methods.rb
+- lib/acts_as_dashboard/line_graph_widget.rb
+- lib/acts_as_dashboard/public/javascripts/dashboard.js
+- lib/acts_as_dashboard/public/stylesheets/dashboard.css
+- lib/acts_as_dashboard/short_messages_widget.rb
+- lib/acts_as_dashboard/widget.rb
+- spec/acts_as_dashboard/class_method_specs.rb
+- spec/acts_as_dashboard/config_spec.rb
+- spec/acts_as_dashboard/instance_methods_spec.rb
+- spec/acts_as_dashboard/line_graph_widget_spec.rb
+- spec/acts_as_dashboard/short_messages_widget_spec.rb
+- spec/acts_as_dashboard/widget_spec.rb
+- spec/acts_as_dashboard_spec.rb
+- spec/shared/widget_behaviours.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/install.rake
+- tasks/install_javascript.rake
+- tasks/install_stylesheets.rake
+has_rdoc: true
+homepage: http://github.com/nickhoffman/acts_as_dashboard
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Create dashboards in Rails apps easily.
+test_files: 
+- spec/acts_as_dashboard_spec.rb
+- spec/spec_helper.rb
+- spec/shared/widget_behaviours.rb
+- spec/acts_as_dashboard/line_graph_widget_spec.rb
+- spec/acts_as_dashboard/config_spec.rb
+- spec/acts_as_dashboard/class_method_specs.rb
+- spec/acts_as_dashboard/short_messages_widget_spec.rb
+- spec/acts_as_dashboard/instance_methods_spec.rb
+- spec/acts_as_dashboard/widget_spec.rb