report_action 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c71bf29dd2b2d28cee02f7fb1ab9da82a9df2b3b9ef2ce6374c867067745ae8c
+  data.tar.gz: ea844fae4f3d60cb9f5a5e053e3475c2ffee03c30fd5501e048a53af28b0bf62
+SHA512:
+  metadata.gz: 1054ef9ba465b01c9711849c22ca8c7d3e98e43dbdbc1c5508e0e738f8ccf26dd633c2f9490d7cbc779968570c9dc31c28688e6c01d665cea63d107af50a0e53
+  data.tar.gz: a788adcdbe8da56e26e8253e00d00a41b6d8e3836c780dfe00d3bab7fb2f4ef1b5f995584cbf02a0565f7122b046f195fec3c21cbb57e2103ee3f1a7de7c257a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+
+# Ignore IDE
+.idea/
+
+.DS_Store

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.2

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.3.0  
+- Initial Release

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in report_action.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 College of Humanities and Social Sciences, George Mason University
+
+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,71 @@
+# ReportAction
+
+A collection of tools for structuring and building simple reports, which can be extracted as a structure or as text with html.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'report_action'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install report_action
+
+## Usage
+
+First, initialize a new report structure:
+```ruby
+my_report = ReportAction::Report.new
+```
+Then add items to your report using this syntax:
+```ruby
+my_report.report_item(process, group, message)
+```
+For example:
+```ruby
+my_report.report_item('Full Task Report', 'Tasks', 'This is a task')
+my_report.report_item('Full Task Report', 'Tasks', 'This is another task')
+my_report.report_item('Full Task Report', 'Results', 'This is a result.')
+my_report.report_item('User Task Report For Ralph', 'Tasks', 'This is a different task.')
+```
+Build a report for a single process as text with html headers and paragraphs:
+```ruby
+my_report.build_report('Full Task Report')
+```
+which returns:
+```html
+<h1>Tasks</h1><p>This is a task</p><p>This is another task</p><h1>Results</h1><p>This is a result.</p>
+```
+List all processes in a report:
+```ruby
+my_report.list_report_processes
+```
+Retrieve the full report structure:
+```ruby
+structure = my_report.retrieve_report_structure
+```
+See if a report has messages for a given process and group:
+```ruby
+my_report.has_messages?('Full Task Report', 'Tasks')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/CraigJZ/report_action.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "report_action"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/report_action.rb

@@ -0,0 +1,44 @@
+require 'report_action/version'
+
+module ReportAction
+  class Error < StandardError; end
+
+  class Report
+    def initialize
+      @report_action = {}
+    end
+
+    def report_item(process, group, message)
+      @report_action[process] ||= {}
+      @report_action[process][group] ||= []
+      @report_action[process][group] << message
+    end
+
+    def list_report_processes
+      @report_action.collect { |p| p.shift }
+    end
+
+    def retrieve_report_structure
+      @report_action
+    end
+
+    def build_report(process)
+      report_body = ''
+      if @report_action.key?(process)
+        @report_action[process].each do |group, messages|
+          report_body += "<h1>#{group.capitalize}</h1>"
+          messages.uniq.sort.each do |message|
+            report_body += "<p>#{message}</p>"
+          end
+        end
+      end
+      report_body
+    end
+
+    def has_messages?(process, group)
+      if @report_action.key?(process)
+        @report_action[process].key?(group)
+      end
+    end
+  end
+end

data/lib/report_action/version.rb

@@ -0,0 +1,3 @@
+module ReportAction
+  VERSION = "0.3.0"
+end

data/report_action.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "report_action/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "report_action"
+  spec.version       = ReportAction::VERSION
+  spec.authors       = ["Danny Collier, Craig Zaccaro"]
+  spec.email         = ["chssweb@gmu.edu"]
+
+  spec.summary       = "Common Reporting Actions"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/CraigJZ/report_action"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/CraigJZ/report_action"
+    spec.metadata["changelog_uri"] = "https://github.com/CraigJZ/report_action/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: report_action
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Danny Collier, Craig Zaccaro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Common Reporting Actions
+email:
+- chssweb@gmu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/report_action.rb
+- lib/report_action/version.rb
+- report_action.gemspec
+homepage: https://github.com/CraigJZ/report_action
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/CraigJZ/report_action
+  source_code_uri: https://github.com/CraigJZ/report_action
+  changelog_uri: https://github.com/CraigJZ/report_action/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Common Reporting Actions
+test_files: []