RubyGems - reporta-modules - Versions diffs - 0.0.1 - Mend

reporta-modules 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (81) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +203 -0
data/Rakefile +20 -0
data/lib/generators/reporta/views_generator.rb +24 -0
data/lib/generators/templates/reports/_box.html.erb +48 -0
data/lib/generators/templates/reports/_chartjs_bar.html.erb +31 -0
data/lib/generators/templates/reports/_chartjs_line.html.erb +33 -0
data/lib/generators/templates/reports/_chartjs_pie.html.erb +19 -0
data/lib/generators/templates/reports/_filters.html.erb +100 -0
data/lib/generators/templates/reports/_table.html.erb +49 -0
data/lib/reporta-modules.rb +15 -0
data/lib/reporta/box_helper.rb +17 -0
data/lib/reporta/chartjs_helper.rb +74 -0
data/lib/reporta/models/column.rb +68 -0
data/lib/reporta/models/filter.rb +42 -0
data/lib/reporta/models/form.rb +77 -0
data/lib/reporta/models/reportable.rb +50 -0
data/lib/reporta/railtie.rb +8 -0
data/lib/reporta/version.rb +3 -0
data/lib/reporta/view_helper.rb +38 -0
data/lib/tasks/reporta_tasks.rake +4 -0
data/spec/dummy/README.rdoc +28 -0
data/spec/dummy/Rakefile +6 -0
data/spec/dummy/app/assets/javascripts/application.js +18 -0
data/spec/dummy/app/assets/javascripts/jquery.dataTables.js +12099 -0
data/spec/dummy/app/assets/javascripts/jquery.flot.js +3061 -0
data/spec/dummy/app/assets/javascripts/jquery.flot.time.js +431 -0
data/spec/dummy/app/assets/javascripts/jquery.js +2 -0
data/spec/dummy/app/assets/stylesheets/application.css +14 -0
data/spec/dummy/app/assets/stylesheets/bootstrap.min.css +9 -0
data/spec/dummy/app/assets/stylesheets/style.css +57 -0
data/spec/dummy/app/controllers/application_controller.rb +3 -0
data/spec/dummy/app/controllers/reports_controller.rb +18 -0
data/spec/dummy/app/helpers/application_helper.rb +5 -0
data/spec/dummy/app/models/account.rb +3 -0
data/spec/dummy/app/models/account_chart.rb +41 -0
data/spec/dummy/app/models/account_report.rb +39 -0
data/spec/dummy/app/models/user.rb +8 -0
data/spec/dummy/app/views/layouts/application.html.erb +28 -0
data/spec/dummy/app/views/reports/chart.html.erb +6 -0
data/spec/dummy/app/views/reports/dynamic_table.html.erb +33 -0
data/spec/dummy/app/views/reports/dynamic_table_with_bootstrap.html.erb +37 -0
data/spec/dummy/app/views/reports/overview.html.erb +4 -0
data/spec/dummy/app/views/reports/table.html.erb +12 -0
data/spec/dummy/bin/bundle +3 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +23 -0
data/spec/dummy/config/boot.rb +5 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +29 -0
data/spec/dummy/config/environments/production.rb +80 -0
data/spec/dummy/config/environments/test.rb +36 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/dummy/config/initializers/inflections.rb +16 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +12 -0
data/spec/dummy/config/initializers/session_store.rb +3 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +23 -0
data/spec/dummy/config/routes.rb +7 -0
data/spec/dummy/db/migrate/20130622041213_create_users.rb +14 -0
data/spec/dummy/db/migrate/20130623054801_create_accounts.rb +9 -0
data/spec/dummy/db/schema.rb +33 -0
data/spec/dummy/db/seeds.rb +20 -0
data/spec/dummy/db/test.sqlite3 +0 -0
data/spec/dummy/log/test.log +1190 -0
data/spec/dummy/public/404.html +58 -0
data/spec/dummy/public/422.html +58 -0
data/spec/dummy/public/500.html +57 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/models/column_spec.rb +76 -0
data/spec/models/filter_spec.rb +63 -0
data/spec/models/form_spec.rb +81 -0
data/spec/models/report_spec.rb +51 -0
data/spec/spec_helper.rb +43 -0
metadata +247 -0

data/spec/dummy/public/404.html ADDED Viewed

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+  }
+  div.dialog {
+    width: 25em;
+    margin: 4em auto 0 auto;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 4em 0 4em;
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  body > p {
+    width: 33em;
+    margin: 0 auto 1em;
+    padding: 1em 0;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</body>
+</html>

data/spec/dummy/public/422.html ADDED Viewed

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+  }
+  div.dialog {
+    width: 25em;
+    margin: 4em auto 0 auto;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 4em 0 4em;
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  body > p {
+    width: 33em;
+    margin: 0 auto 1em;
+    padding: 1em 0;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</body>
+</html>

data/spec/dummy/public/500.html ADDED Viewed

@@ -0,0 +1,57 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+  }
+  div.dialog {
+    width: 25em;
+    margin: 4em auto 0 auto;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 4em 0 4em;
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  body > p {
+    width: 33em;
+    margin: 0 auto 1em;
+    padding: 1em 0;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</body>
+</html>

data/spec/dummy/public/favicon.ico ADDED Viewed

File without changes

data/spec/models/column_spec.rb ADDED Viewed

@@ -0,0 +1,76 @@
+# Copyright 2013-2014 University of Technology, Sydney (github.com/uts)
+# 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.
+require 'spec_helper'
+require 'date'
+class ColumReport
+  include Reporta::Column
+  column :name
+  column :full_name
+  column :date, title: 'Completed at'
+  column :formatted_date
+  column :customer_name, data_chain: 'customer.name'
+  column :email_customer, helper: :customer_email_link
+  def formatted_date(project)
+    project.created_at.strftime('%b %d, %Y')
+  end
+end
+describe Reporta::Column do
+  it 'initializes columns' do
+    expect { ColumReport.column :name }.to_not raise_error
+  end
+  context 'with columns defined' do
+    subject(:report) { ColumReport.new }
+    it 'defaults to the column name' do
+      expect(report.columns[:full_name].title).to eq 'Full name'
+    end
+    it 'sets a custom title' do
+      expect(report.columns[:date].title).to eq 'Completed at'
+    end
+    it 'returns the value using a local method' do
+      project = double created_at: Date.new(2013, 01, 15)
+      expect(
+        report.value_for(project, :formatted_date)
+      ).to eq 'Jan 15, 2013'
+    end
+    it 'uses a chain of methods of fetch the value' do
+      customer = double name: 'World Co.'
+      project = double customer: customer
+      expect(report.value_for(project, :customer_name))
+        .to eq 'World Co.'
+    end
+    it 'sets a custom helper' do
+      expect(report.columns[:email_customer].helper).to eq :customer_email_link
+    end
+  end
+end

data/spec/models/filter_spec.rb ADDED Viewed

@@ -0,0 +1,63 @@
+# Copyright 2013-2014 University of Technology, Sydney (github.com/uts)
+# 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.
+require 'spec_helper'
+class FilteredReport
+  include Reporta::Filter
+  filter :start_date, default: '2013-01-01'
+  filter :finish_date
+  filter :active, as: :boolean
+  filter :employee_type, required: true
+  filter :age, include_blank: false
+  filter :be_blank_true
+  filter :valid, collection: %w/true false/
+end
+describe Reporta::Filter do
+  context 'with columns defined' do
+    subject(:report) { FilteredReport.new }
+    it 'defaults to correct date' do
+      expect(report.filters[:start_date].default).to eq '2013-01-01'
+    end
+    it 'accepts boolean column types' do
+      expect(report.filters[:active].as).to eq :boolean
+    end
+    it 'requires columns to be set' do
+      expect(report.filters[:employee_type].required).to eq true
+    end
+    it 'allows include_blank to bet set' do
+      expect(report.filters[:age].include_blank).to eq false
+    end
+    it 'defaults include_blank to true' do
+      expect(report.filters[:be_blank_true].include_blank).to eq true
+    end
+    it 'allows collections to be set' do
+      expect(report.filters[:valid].collection).to eq %w/true false/
+    end
+  end
+end

data/spec/models/form_spec.rb ADDED Viewed

@@ -0,0 +1,81 @@
+# Copyright 2013-2014 University of Technology, Sydney (github.com/uts)
+# 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.
+require 'spec_helper'
+require 'ostruct'
+class FormFilters
+  include Reporta::Filter
+  filter :active, as: :boolean
+  filter :start_date, default: '2013-01-01', required: true
+  filter :name, required: true
+end
+describe Reporta::Form do
+  let(:filters) { FormFilters.new.filters }
+  it 'is initialized with filters and default values' do
+    expect { Reporta::Form.new filters, {} }.to_not raise_error
+  end
+  it 'stores and retreives values based on the filter name' do
+    form = Reporta::Form.new filters
+    expect(form.active).to be false
+    form.active = true
+    expect(form.active).to be true
+  end
+  it 'falls back to the filter default value if set' do
+    form = Reporta::Form.new filters
+    expect(form.start_date).to eq '2013-01-01'
+  end
+  it 'adds an error message on validation when a required field is missing' do
+    form = Reporta::Form.new filters
+    expect(form.valid?).to be false
+    expect(form.errors[:name].to_s).to match /required/
+  end
+  describe 'filters_applied?' do
+    it 'is false when no values are initialized' do
+      form = Reporta::Form.new filters
+      expect(form.filter_applied?).to be false
+    end
+    it 'is true when one or more values are initialized' do
+      form = Reporta::Form.new filters, active: true
+      expect(form.filter_applied?).to be true
+    end
+  end
+  context 'with boolean filter' do
+    it 'converts boolean "0" to false' do
+      form = Reporta::Form.new filters, active: '0'
+      expect(form.active).to be false
+    end
+    it 'converts boolean "1" to true' do
+      form = Reporta::Form.new filters, active: '1'
+      expect(form.active).to be true
+    end
+  end
+end

data/spec/models/report_spec.rb ADDED Viewed

@@ -0,0 +1,51 @@
+# Copyright 2013-2014 University of Technology, Sydney (github.com/uts)
+# 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.
+require 'spec_helper'
+class BaseReport
+  include Reporta::Reportable
+  filter :active, as: :boolean
+  filter :start_date
+end
+describe Reporta::Reportable do
+  it 'can be initialized' do
+    expect { BaseReport.new }.to_not raise_error
+  end
+  it 'initializes and validates a new Form' do
+    args = { name: 'Joe' }
+    filters = double()
+    form = double()
+    expect(form).to receive(:valid?)
+    expect(Reporta::Form).to receive(:new).with(filters, args).and_return form
+    BaseReport.any_instance.stub(:filters).and_return(filters)
+    BaseReport.new args
+  end
+  it 'allows a filter value to be set and retrieved' do
+    report = BaseReport.new start_date: '2013-01-19'
+    expect(report.start_date).to eq '2013-01-19'
+  end
+end