stat_board 0.1.8 → 0.1.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 714d8cf51a57406f3e98bce6f897cdcfc0e9a9d7
+  data.tar.gz: fa217da108f3d63a92d3e7b952e15c5f8c060a8f
+SHA512:
+  metadata.gz: f645fa8393b2eac0e327cf21bc684ae8fc9b2f343770c9b4d8f5bdd74e2f09916aa405228963e98b8c3d22ee72755dbbc52b7c75c678c879f7c8451ea4db6d63
+  data.tar.gz: 53320913aad40ed6d6d1c2a9ce4b722607bcc7cb685d38109ef39be9d84b48d3d3816421504fda343158f5d4be15a9c861cee3553785f01d3f7198080302b853

data/README.markdown

@@ -13,10 +13,9 @@ A simple dashboard of records created this week, this month, and all time, mount
 
         gem 'stat_board'
 
-2. Mount engine (in `config/routes.rb`):
+2. Add initializer and route:
 
-        YourApp::Application.routes.draw do
-          mount StatBoard::Engine, :at => "/stats"
+        rails g stat_board:install
 
 3. Configure models (in `config/initializers/stat_board.rb`):
 
@@ -24,6 +23,12 @@ A simple dashboard of records created this week, this month, and all time, mount
 
 Models can also be listed as strings if you encounter any loading order issues.
 
+## Routing
+
+You can access StatBoard like this:
+
+    stat_board.root_url
+
 ## Additonal Configuration
 
 In `config/initializers/stat_board.rb`:
@@ -41,6 +46,23 @@ In `config/initializers/stat_board.rb`:
 
         StatBoard.display_graph = true
 
+4. You may provide your own reports, just place they into `lib/stat_board/reports`. Name of report should be `*_report.rb`. For example:
+
+        # lib/stat_board/reports/day_report.rb
+        module StatBoard
+          module Reports
+            class DayReport < Report
+              def name(original_date = nil)
+                "Last day"
+              end
+
+              def scope(model)
+                super.where(["created_at > ?", 1.day.ago])
+              end
+            end
+          end
+        end
+
 ## Issues
 
   * Models can be specified as strings rather than constants

data/app/controllers/stat_board/stats_controller.rb

@@ -5,11 +5,7 @@ module StatBoard
     before_filter :basic_authenticate, :if => lambda { StatBoard.username && StatBoard.password }
 
     def index
-      @reports = [
-        Reports::OverallReport.new,
-        Reports::MonthlyReport.new,
-        Reports::WeeklyReport.new
-      ]
+      @reports = ReportsFinder.all
     end
 
     private

data/lib/generators/stat_board/install_generator.rb

@@ -0,0 +1,17 @@
+module StatBoard
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "creates an initializer file at config/initializers/stat_board.rb and adds StatBoard route to config/routes.rb"
+      source_root File.expand_path("../templates", __FILE__)
+
+      def generate_initialization
+        copy_file 'initializer.rb', 'config/initializers/stat_board.rb'
+      end
+
+      def generate_routing
+        route "mount StatBoard::Engine, at: 'stats'"
+        log "# You can access StatBoard url like this: stat_board.root_url #=> '/stats'"
+      end
+    end
+  end
+end

data/lib/generators/stat_board/templates/initializer.rb

@@ -0,0 +1 @@
+# StatBoard.models = [User, Post, Comment] # configure models

data/lib/stat_board.rb

@@ -4,6 +4,7 @@ require "stat_board/reports/overall_report"
 require "stat_board/reports/monthly_report"
 require "stat_board/reports/weekly_report"
 require "stat_board/graph_helper"
+require "stat_board/reports_finder"
 
 module StatBoard
   mattr_accessor :models, :title, :display_graph, :username, :password

data/lib/stat_board/reports_finder.rb

@@ -0,0 +1,14 @@
+module StatBoard
+  class ReportsFinder < Struct.new(:directory)
+    def reports
+      Dir[File.join(directory, "/*_report.rb")].map do |report|
+        "StatBoard::Reports::#{File.basename(report, ".rb").camelcase}".constantize.new
+      end
+    end
+
+    def self.all
+      self.new(File.join(StatBoard::Engine.root, "lib/stat_board/reports")).reports +
+      self.new(File.join(Rails.root, "lib/stat_board/reports")).reports
+    end
+  end
+end

data/lib/stat_board/version.rb

@@ -1,3 +1,3 @@
 module StatBoard
-  VERSION = '0.1.8'
+  VERSION = '0.1.9'
 end

metadata

@@ -1,100 +1,88 @@
 --- !ruby/object:Gem::Specification
 name: stat_board
 version: !ruby/object:Gem::Version
-  version: 0.1.8
-  prerelease: 
+  version: 0.1.9
 platform: ruby
 authors:
 - David Eisinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2014-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -110,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara-webkit
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -126,49 +111,43 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Simple dashboard of records created this week, this month, and all time,
@@ -188,12 +167,15 @@ files:
 - app/views/stat_board/stats/_graph.html.erb
 - app/views/stat_board/stats/index.html.erb
 - config/routes.rb
+- lib/generators/stat_board/install_generator.rb
+- lib/generators/stat_board/templates/initializer.rb
 - lib/stat_board/engine.rb
 - lib/stat_board/graph_helper.rb
 - lib/stat_board/reports/monthly_report.rb
 - lib/stat_board/reports/overall_report.rb
 - lib/stat_board/reports/report.rb
 - lib/stat_board/reports/weekly_report.rb
+- lib/stat_board/reports_finder.rb
 - lib/stat_board/version.rb
 - lib/stat_board.rb
 - lib/tasks/stat_board_tasks.rake
@@ -203,27 +185,26 @@ files:
 homepage: https://github.com/vigetlabs/stat_board
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple dashboard of records created this week, this month, and all time,
   mountable as a Rails Engine.
 test_files: []