simple_report 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f98c990ab100b1bbbbfe334f4ece710ed895f682
+  data.tar.gz: b4f0681aaddd82c82a6731ba74670355b622cf1d
+SHA512:
+  metadata.gz: f506009a364c546294118f3d5d97ebae95c70ff4b0d40aec84391c3fd47aba6335ffcaed42b113d2e6b8d174a529013c5e94bb1e5de3b726fa83cf2b544200ec
+  data.tar.gz: 4a62e6e447fee563d3befd74bc28cfc03ba311c4cec22fdecd14346f3b53bb60bd45c8a649dc898eeca7a5cdad7f9de6f131929a054de990cc960385a1b4844d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.8
+  - 2.3.5
+  - 2.4.2
+  - ruby-head
+addons:
+  code_climate:
+    repo_token: d81350f440f981f869cc37fff76ba610a27e6b2bd442999057e9ad18100216dc
+# regular test configuration
+after_success:
+  - bundle exec codeclimate-test-reporter

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/lostapathy/simple_report" }
+
+# Specify your gem's dependencies in simple_report.gemspec
+gemspec
+
+group :test do
+  gem "simplecov"
+  gem "codeclimate-test-reporter", "~> 1.0.0"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Joe Francis
+
+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,42 @@
+# SimpleReports
+
+[![Build Status](https://travis-ci.org/lostapathy/simple_report.svg?branch=master)](https://travis-ci.org/lostapathy/simple_report)
+[![Code Climate](https://api.codeclimate.com/v1/badges/04ced70d7b66d1a7c42d/maintainability)](https://codeclimate.com/github/lostapathy/simple_report)
+[![Test Coverage](https://codeclimate.com/github/lostapathy/simple_report/badges/coverage.svg)](https://codeclimate.com/github/lostapathy/simple_report/coverage)
+
+
+simple_report is a gem for building simple reports from Enumerable collections.  It was extracted from a larger application and only supports Excel exports for now, but other formats could be added.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_report'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_report
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.
+
+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/lostapathy/simple_report.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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/lib/simple_report.rb

@@ -0,0 +1,8 @@
+require "simple_report/version"
+require "simple_report/base"
+require "simple_report/sheet"
+require "simple_report/field"
+
+module SimpleReport
+  # Your code goes here...
+end

data/lib/simple_report/base.rb

@@ -0,0 +1,70 @@
+module SimpleReport
+  class Base
+    def add_format(name, format)
+      @formats ||= {}
+      @formats[name] = format
+    end
+
+    def initialize
+      @file = Tempfile.new('simple_report')
+      @workbook = WriteXLSX.new(@file.path)
+      money = @workbook.add_format
+      money.set_num_format('$0.00')
+      add_format :money, money
+
+      heading = @workbook.add_format
+      heading.set_bold
+      add_format :heading, heading
+
+      percent = @workbook.add_format
+      percent.set_num_format('0%')
+      add_format :percent, percent
+    end
+
+    def report_xls(*params)
+      report(*params)
+      @workbook.close
+      File.read @file.path
+    end
+
+    private
+
+    def add_sheet(name, data)
+      sheet = Sheet.new(name)
+      @fields = []
+      sheet = @workbook.add_worksheet(name)
+      yield
+      @sheets ||= []
+      @sheets << sheet
+
+      @fields.each_with_index do |f, index|
+        sheet.set_column(index, index, f.width)
+        sheet.write(0, index, f.name, @formats[:heading])
+      end
+
+      data.each_with_index do |ic, row|
+        @fields.each_with_index do |field, column|
+          if field.field
+            value = ic.send(field.field)
+          elsif field.value
+            value = field.value
+          elsif field.block
+            value = field.block.call(ic)
+          end
+          sheet.write(row + 1, column, value, find_format(field.format))
+        end
+      end
+    end
+
+    def field(name, field = nil, width: nil, format: nil, value: nil, &block)
+      rf = Field.new(name, field, width: width, format: format, value: value, &block)
+      @fields << rf
+    end
+
+    private
+
+    def find_format(format)
+      @formats[format]
+    end
+  end
+end

data/lib/simple_report/field.rb

@@ -0,0 +1,14 @@
+module SimpleReport
+  class Field
+    attr_reader :name, :width, :block, :format, :field, :value
+
+    def initialize(name, field, format: nil, width: 10, value: nil, &block)
+      @name = name
+      @field = field
+      @width = width
+      @value = value
+      @block = block
+      @format = format
+    end
+  end
+end

data/lib/simple_report/sheet.rb

@@ -0,0 +1,7 @@
+module SimpleReport
+  class Sheet
+    def initialize(name)
+      @name = name
+    end
+  end
+end

data/lib/simple_report/version.rb

@@ -0,0 +1,3 @@
+module SimpleReport
+  VERSION = "0.1.0"
+end

data/simple_report.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "simple_report/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_report"
+  spec.version       = SimpleReport::VERSION
+  spec.authors       = ["Joe Francis"]
+  spec.email         = ["joe@lostapathy.com"]
+
+  spec.summary       = %q{Generate simple reports.}
+  spec.description   = %q{Generate simple reports from Enumerable collections, from simple Arrays to ActiveRecord Collections. }
+  spec.homepage      = "https://github.com/lostapathy/simple_report"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "write_xlsx", '~> 0.85.1'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: simple_report
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joe Francis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: write_xlsx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.85.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.85.1
+description: 'Generate simple reports from Enumerable collections, from simple Arrays
+  to ActiveRecord Collections. '
+email:
+- joe@lostapathy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_report.rb
+- lib/simple_report/base.rb
+- lib/simple_report/field.rb
+- lib/simple_report/sheet.rb
+- lib/simple_report/version.rb
+- simple_report.gemspec
+homepage: https://github.com/lostapathy/simple_report
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Generate simple reports.
+test_files: []