cells-dashboard 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b3e98c82548f3b5a9e5442d2d9a3c995ce47bb7
+  data.tar.gz: 4f9f74ad9ee27b3ae7c3df4b9086401904309f56
+SHA512:
+  metadata.gz: 904f958c8c75541b0e1d7bce6c9d2ae5b674007726820f1fe675973ef7b037ac254155e2c5cf42185cb53e4ae56b44271d1360f3065aa843e694682d0b092506
+  data.tar.gz: 1be6696dc04e768c6f8a12f4f9a5336f6ead369c08648dd7aefbf6d2ffeff1bbb7ce5a0d0e975843e7fef1f9904b5f6c5955f969a1de3eca42d5bd5ef9c19ce7

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cells-dashboard.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ben Morrall
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# cells-dashboard
+
+Adds a DSL to the [apotonick/cells](https://github.com/apotonick/cells) gem that allows for grouping of cells (as widgets) into multiple independent Dashboards.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cells'
+gem 'cells-dashboard'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cells-dashboard
+
+## Usage
+
+Define your dashboards in your initializer (`config/initializers/cells_dashboard.rb`), using blocks with matching arguments to control if a cell should be diplayed.
+
+```ruby
+# Define a dashboard named `users`
+Cells::Dashboard.create :users do
+  # Render the `Users::ChangePasswordCell` cell, if the users password has expired
+  add_widget 'users/change_password' do |user|
+    user.password_expired?
+  end
+
+  # Render the `Users::HappyBirthdayCell` if today is the user's birthday
+  add_widget 'users/happy_birthday' do |user|
+    user.birthday == Date.today
+  end
+
+  # Render the `Users::CompletedProfileCell` if none of the conditional widgets will be displayed
+  fallback 'users/completed_profile'
+end
+```
+
+Define your cells, using a `#display` method that accepts the same arguments as the blocks in your initializer.
+
+```ruby
+# app/cells/users/change_password_cell.rb
+class Users::ChangePasswordCell < Cell::Rails
+  def display(user)
+    @user = user
+    render
+  end
+end
+```
+
+Add a `#render_dashboard` call to your views, ensuring the arguments given match the name of your dashboard, the conditional blocks in your initializer, and the `#display` methods in your cells.
+
+```erb
+<%- render_dashboard :users, current_user %>
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/cells-dashboard/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task default: :test

data/app/helpers/cells/dashboard_helper.rb

@@ -0,0 +1,10 @@
+module Cells
+  module DashboardHelper
+    def render_dashboard(dashboard_name, *args)
+      widgets = Cells::Dashboard.dashboard_widgets(dashboard_name, *args)
+      widgets.each do |widget|
+        concat render_cell(widget.cell_name, :display, *args)
+      end
+    end
+  end
+end

data/cells-dashboard.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cells/dashboard/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cells-dashboard"
+  spec.version       = Cells::Dashboard::VERSION
+  spec.authors       = ["Ben Morrall"]
+  spec.email         = ["bemo56@hotmail.com"]
+  spec.summary       = %q{A Simple DSL for rendering Cells as a Dashboard}
+  spec.description   = %q{Adds a DSL to the apotonick/cells gem that allows for grouping of cells (as widgets) into multiple independent Dashboards}
+  spec.homepage      = "https://github.com/bmorrall/cells-dashboard"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'cells'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/cells/dashboard.rb

@@ -0,0 +1,35 @@
+require "cells/dashboard/version"
+
+module Cells
+  module Dashboard
+    require "cells/dashboard/context"
+    require "cells/dashboard/widget"
+
+    class << self
+      # Adds a newly defined dashboard
+      def create(dashboard_name, &block)
+        context = dashboard(dashboard_name)
+        context.instance_eval(&block)
+        context.freeze
+      end
+
+      # Returns all widgets to be rendered for a dashboard
+      def dashboard_widgets(dashboard_name, *args)
+        dashboard(dashboard_name).widgets_for_arguments(*args)
+      end
+
+      protected
+
+      def dashboard(dashboard_name)
+        @dashboards ||= {}
+        @dashboards[dashboard_name.to_sym] ||= Context.new
+      end
+    end
+  end
+end
+
+if defined?(ActionController)
+  require File.join(File.dirname(__FILE__), '..', '..', 'app', 'helpers', 'cells', 'dashboard_helper')
+  ActionController::Base.helper(Cells::DashboardHelper)
+end
+

data/lib/cells/dashboard/context.rb

@@ -0,0 +1,38 @@
+module Cells::Dashboard
+  class Context
+    # Adds a widget to a list of possible widgets
+    # @param [&block] should return true when displayed within a view context
+    def add_widget(cell_name, &block)
+      widgets << Widget.new(cell_name, &block)
+    end
+
+    # Adds a fallback widget in the event no widgets are displayed
+    def fallback(cell_name)
+      fallback_widgets << Widget.new(cell_name)
+    end
+
+    def freeze
+      fallback_widgets.freeze
+      widgets.freeze
+      super
+    end
+
+    # Only displays widgets that evaluate to true for `args`
+    def widgets_for_arguments(*args)
+      context_widgets = widgets.select { |widget| widget.display? *args }
+      context_widgets.any? ? context_widgets : fallback_widgets
+    end
+
+    protected
+
+    # Widgets that are conditionally tested for display
+    def widgets
+      @widgets ||= []
+    end
+
+    # Widgets that are returned when no widgets are to be displayed
+    def fallback_widgets
+      @fallback_widgets ||= []
+    end
+  end
+end

data/lib/cells/dashboard/version.rb

@@ -0,0 +1,5 @@
+module Cells
+  module Dashboard
+    VERSION = "0.0.1"
+  end
+end

data/lib/cells/dashboard/widget.rb

@@ -0,0 +1,34 @@
+require 'active_support/core_ext/string/inflections'
+
+module Cells::Dashboard
+  class Widget
+    attr_reader :cell_name
+
+    def self.name_for_cell(cell_name)
+      case cell_name
+      when Class
+        # Accept Cell classes
+        name_for_cell(cell_name.name)
+      when Array
+        # Accept arrays of values
+        cell_name
+      else
+        # Accept the name of cells (safely removing cell suffix)
+        cell_name.to_s.underscore.sub(/_cell\z/, '')
+      end
+    end
+
+    # Creates a new widget that:
+    # - renders the #display method of a cell found using `cell_name`
+    # - renders only if `block` evaluates to true
+    def initialize(cell_name, &block)
+      @cell_name = Widget.name_for_cell(cell_name).freeze
+      @block = block if block_given?
+    end
+
+    # Returns true if the cell should be displayed
+    def display?(*args)
+      @block.nil? || !!@block.call(*args)
+    end
+  end
+end

data/test/cells/dashboard/context_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+describe Cells::Dashboard::Context do
+
+  describe '#freeze' do
+    it 'should prevent the user from adding widgets' do
+      context = Cells::Dashboard::Context.new
+      context.freeze
+      begin
+        context.add_widget 'enabled_widget'
+        fail 'error should have been raised'
+      rescue RuntimeError
+        # Pass!
+      end
+    end
+    it 'should prevent the user from adding a fallback' do
+      context = Cells::Dashboard::Context.new
+      context.freeze
+      begin
+        context.fallback 'enabled_widget'
+        fail 'error should have been raised'
+      rescue RuntimeError
+        # Pass!
+      end
+    end
+  end
+
+  describe '#widgets_for_arguments' do
+    it 'should return all widgets where display returns to true' do
+      context = Cells::Dashboard::Context.new
+      context.add_widget 'enabled_widget' do
+        true
+      end
+      context.add_widget 'disabled_widget' do
+        false
+      end
+      result = context.widgets_for_arguments
+      result.size.must_equal 1
+      result[0].cell_name.must_equal 'enabled_widget'
+    end
+    it 'should pass all arguments to the display methods on each widget' do
+      received_value = nil
+      context = Cells::Dashboard::Context.new
+      context.add_widget 'enabled_widget' do |argument_value|
+        received_value = argument_value
+      end
+      context.widgets_for_arguments 'example_argument'
+      received_value.must_equal 'example_argument'
+    end
+    it 'should return the fallback value if no widgets are enabled' do
+      context = Cells::Dashboard::Context.new
+      context.add_widget 'enabled_widget' do |argument_value|
+        false
+      end
+      context.fallback 'fallback_widget'
+      result = context.widgets_for_arguments
+      result.size.must_equal 1
+      result[0].cell_name.must_equal 'fallback_widget'
+    end
+  end
+end

data/test/cells/dashboard/widget_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+describe Cells::Dashboard::Widget do
+  describe '.name_for_widget' do
+    it 'handles Class values' do
+      class Cells::Dashboard::ExampleCell; end
+      Cells::Dashboard::Widget.name_for_cell(Cells::Dashboard::ExampleCell).must_equal 'cells/dashboard/example'
+    end
+    it 'handles Array values' do
+      Cells::Dashboard::Widget.name_for_cell(['a', :b, 'C']).must_equal ['a', :b, 'C']
+    end
+    it 'handles String parameters' do
+      Cells::Dashboard::Widget.name_for_cell('my_widgets/example_widget_cell').must_equal 'my_widgets/example_widget'
+    end
+  end
+
+  describe '#display?' do
+    it 'returns true with no block value' do
+      widget = Cells::Dashboard::Widget.new('example_widget')
+      widget.display?.must_equal true
+    end
+    it 'returns the value from the block' do
+      return_value = [true, false].sample
+      widget = Cells::Dashboard::Widget.new('example_widget') do
+        return_value
+      end
+      widget.display?.must_equal return_value
+    end
+    it 'passes all arguments to the block value' do
+      received_value_a = received_value_b = nil
+      widget = Cells::Dashboard::Widget.new('example_widget') do |argument_value_a, argument_value_b|
+        received_value_a = argument_value_a
+        received_value_b = argument_value_b
+      end
+      widget.display? 'value a', 'value b'
+      received_value_a.must_equal 'value a'
+      received_value_b.must_equal 'value b'
+    end
+  end
+end

data/test/cells/dashboard_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+describe Cells::Dashboard do
+  after(:each) do
+    Cells::Dashboard.instance_variable_set '@dashboards', nil
+  end
+
+  describe '.create' do
+    it 'should provide a dsl based off a Context object' do
+      Cells::Dashboard.create :example do
+        add_widget 'example_widget'
+        fallback 'fallback_widget'
+      end
+    end
+  end
+
+  describe '.dashboard_widgets' do
+    it 'should return displayed widgets with a matching dashboard name' do
+      Cells::Dashboard.create :matching_name do
+        add_widget('matching_widget') { true }
+      end
+      Cells::Dashboard.create :other_name do
+        add_widget('other_widget') { true }
+      end
+      result = Cells::Dashboard.dashboard_widgets(:matching_name)
+      result.size.must_equal 1
+      result[0].cell_name.must_equal 'matching_widget'
+    end
+    it 'should return all widgets that evaluate for true in a given context' do
+      Cells::Dashboard.create :example do
+        add_widget('enabled_widget') { true }
+        add_widget('disabled_widget') { false }
+      end
+      result = Cells::Dashboard.dashboard_widgets(:example)
+      result.size.must_equal 1
+      result[0].cell_name.must_equal 'enabled_widget'
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'cells/dashboard'
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/pride'

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: cells-dashboard
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Morrall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cells
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Adds a DSL to the apotonick/cells gem that allows for grouping of cells
+  (as widgets) into multiple independent Dashboards
+email:
+- bemo56@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/helpers/cells/dashboard_helper.rb
+- cells-dashboard.gemspec
+- lib/cells/dashboard.rb
+- lib/cells/dashboard/context.rb
+- lib/cells/dashboard/version.rb
+- lib/cells/dashboard/widget.rb
+- test/cells/dashboard/context_test.rb
+- test/cells/dashboard/widget_test.rb
+- test/cells/dashboard_test.rb
+- test/test_helper.rb
+homepage: https://github.com/bmorrall/cells-dashboard
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A Simple DSL for rendering Cells as a Dashboard
+test_files:
+- test/cells/dashboard/context_test.rb
+- test/cells/dashboard/widget_test.rb
+- test/cells/dashboard_test.rb
+- test/test_helper.rb
+has_rdoc: