report_generator 1.0.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab28fc424c43db604151cd53025498f9c51d61be
+  data.tar.gz: 19a761e6dfbe01353bee0f1e012988cb7e225b23
+SHA512:
+  metadata.gz: 7527c29a2e1cc669c3a90e19f4bd34a8a9b1910aed795f2df1e1a0bc6cd36f523d47cba4606c4de06c3ed9f840d93805d0a1e1cd286f9c9a6aa2c3c07db15e1b
+  data.tar.gz: 6f79bcbb9ee6182a8f7025bc5d8ffaa9ca583d8afdda5bcc3c65789504fc34d2681ca7f018c5756044771ceb37c642da4e6b48853760a62a2ade9b06e1ee5ea9

data/.gitignore

@@ -0,0 +1,37 @@
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/secrets.yml
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.ruby-version
+.ruby-gemset
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Evan Chiu
+
+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,14 @@
+# report_generator [![Gem Version](https://badge.fury.io/rb/report_generator.png)](http://badge.fury.io/rb/report_generator)
+
+A simple Ruby Internal DSL for creating  Count Report which save data from MySQL to MySQL.
+
+
+## Installation
+
+Add this to your Gemfile:
+
+```ruby
+gem "report_generator"
+```
+
+and run `bundle install`.

data/lib/report_generator/definers/report_definer.rb

@@ -0,0 +1,11 @@
+module ReportGenerator
+  module Definers
+    class ReportDefiner
+      def report name, &block
+        report_factory = ReportGenerator::Factories::ReportFactory.new
+        report_factory.instance_eval(&block) if block_given?
+        ReportGenerator.report_factories[name] = report_factory
+      end
+    end
+  end
+end

data/lib/report_generator/definers/section_definer.rb

@@ -0,0 +1,11 @@
+module ReportGenerator
+  module Definers
+    class SectionDefiner
+      def section name, &block
+        section_factory = ReportGenerator::Factories::SectionFactory.new
+        section_factory.instance_eval(&block) if block_given?
+        ReportGenerator.section_factories[name] = section_factory
+      end
+    end
+  end
+end

data/lib/report_generator/factories/attrs_factory.rb

@@ -0,0 +1,16 @@
+module ReportGenerator
+  module Factories
+    class AttrsFactory
+      attr_reader :attributes
+
+      def initialize
+        @attributes = {}
+      end
+
+      def method_missing(name, *args, &block)
+        @attributes[name] = args[0]
+      end
+
+    end
+  end
+end

data/lib/report_generator/factories/report_factory.rb

@@ -0,0 +1,35 @@
+module ReportGenerator
+  module Factories
+    class ReportFactory
+      attr_reader :attributes
+
+      def initialize
+        @attributes = {}
+        @attributes[:initialize_fields] = {}
+        @attributes[:report_fields] = {}
+      end
+
+      def initialize_fields *args, &block
+        if args.present?
+          args.each{|x| @attributes[:initialize_fields][x]}
+        end
+        if block_given?
+          attrs_factory = AttrsFactory.new
+          attrs_factory.instance_eval(&block)
+          @attributes[:initialize_fields].merge!(attrs_factory.attributes)
+        end
+      end
+
+      def field *names, &block
+        field_factory = ReportGenerator::Factories::ReportFieldFactory.new
+        field_factory.instance_eval(&block) if block_given?
+        @attributes[:report_fields][names] = field_factory.attributes
+      end
+
+      def method_missing(name, *args, &block)
+        @attributes[name] = args[0]
+      end
+
+    end
+  end
+end

data/lib/report_generator/factories/report_field_factory.rb

@@ -0,0 +1,29 @@
+module ReportGenerator
+  module Factories
+    class ReportFieldFactory
+      attr_reader :attributes
+
+      def initialize
+        @attributes = {}
+        @attributes[:section_columns] = []
+      end
+
+      def section name
+        @attributes[:section] = name
+      end
+
+      def column column_name
+        @attributes[:section_columns] << column_name
+      end
+
+      def columns *args
+        @attributes[:section_columns] += args
+      end
+
+      def method_missing(name, *args, &block)
+        @attributes[name] = args
+      end
+
+    end
+  end
+end

data/lib/report_generator/factories/section_factory.rb

@@ -0,0 +1,76 @@
+module ReportGenerator
+  module Factories
+    class SectionFactory
+      attr_reader :attributes
+
+      def initialize
+        @attributes = {}
+        @attributes[:select_columns] = []
+        @attributes[:conditions] = []
+        @attributes[:group_columns] = []
+        @attributes[:sum_groups] = {}
+        @attributes[:joins] = []
+      end
+
+      def mixin section_name, options = {}
+        tmp_sf_attrs = ReportGenerator.section_factories[section_name].attributes.dup
+        except_items = options[:except]
+        if except_items
+          tmp_except_items = except_items.is_a?(Array) ? except_items : [except_items]
+          tmp_except_items.each{|x| tmp_sf_attrs.delete(x)}
+        end
+        @attributes.merge!(tmp_sf_attrs)
+      end
+
+      def data_source kclass
+        @attributes[:data_source] = kclass
+      end
+
+      def select *cols
+        @attributes[:select_columns] +=  cols
+      end
+
+      def count *cols
+        @attributes[:select_columns] += cols.collect do |x|
+          "COUNT(#{x}) count_#{x.to_s.gsub('.', '_')}"
+        end
+      end
+
+      def distinct_count *cols
+        @attributes[:select_columns] += cols.collect do |x|
+          "COUNT(DISTINCT #{x}) count_distinct_#{x.to_s.gsub('.', '_')}"
+        end
+      end
+
+      def sum *cols
+        @attributes[:select_columns] += cols.collect{|x| "SUM(#{x})"}
+      end
+
+      def condition *arg, &block
+        @attributes[:conditions]  += arg
+        if block_given?
+          attrs_factory = AttrsFactory.new
+          attrs_factory.instance_eval(&block)
+          @attributes[:conditions] << attrs_factory.attributes
+        end
+      end
+
+      def group *arg
+        @attributes[:select_columns] += arg
+        @attributes[:group_columns] += arg
+      end
+
+      def sum_group col, manager = nil
+        @attributes[:sum_groups][col] = manager
+      end
+
+      def join join_clause
+        @attributes[:joins] << join_clause
+      end
+
+      def method_missing(name, *args, &block)
+        @attributes[name] = args[0]
+      end
+    end
+  end
+end

data/lib/report_generator/helpers/query_builder.rb

@@ -0,0 +1,13 @@
+module ReportGenerator
+  module Helpers
+    module QueryBuilder
+      def query data_source, select_columns, joins, conditions, group_columns
+        result = data_source
+        result = data_source.select(select_columns) if select_columns.present?
+        joins.each{|x| result = result.joins(x)}
+        conditions.each{|x| result = result.where(x)}
+        result.group(group_columns)
+      end
+    end
+  end
+end

data/lib/report_generator/models/report.rb

@@ -0,0 +1,87 @@
+module ReportGenerator
+  module Models
+    class Report
+      attr_accessor :name, :initialize_fields, :report_fields, :blank_init_fields, :fields_maps
+
+      def perform
+        prepare
+        integration_records = integrate_sections
+        grouped_records = gen_grouped_records(integration_records)
+        merged_records = merge_grouped_records(grouped_records)
+        save(merged_records)
+      end
+
+      private
+      def report_class
+        @name
+      end
+
+      def gen_initialize_fields report_field_name, record
+        result = @initialize_fields.dup
+        result.tap do |x|
+          @blank_init_fields.each_with_index do |blank_field_name, idx|
+            x[blank_field_name] = record.send(@fields_maps[report_field_name][blank_field_name])
+          end
+        end
+      end
+
+      def init_blank_init_fields
+        @blank_init_fields = @initialize_fields.collect{|k,v| k if v.blank?}.compact
+      end
+
+      def init_fields_maps
+        @fields_maps = {}.tap do |x|
+          @report_fields.each do |report_field_name, report_field_attrs|
+            tmp_report_fields = @blank_init_fields + report_field_name
+            x[report_field_name] = {}
+            tmp_report_fields.each_with_index do |field_name, idx|
+              x[report_field_name][field_name] = report_field_attrs[:section_columns][idx]
+            end
+          end
+        end
+      end
+
+      def prepare
+        init_blank_init_fields
+        init_fields_maps
+      end
+
+      def gen_grouped_records records
+        records.group_by{|r| r[:init_fields]}
+      end
+
+      def merge_grouped_records grouped_records
+        {}.tap do |x|
+          grouped_records.each do |group_key, records|
+            tmp_records = records.each{|x| x.delete(:init_fields)}
+            x[group_key]=tmp_records.inject(&:merge)
+          end
+        end
+      end
+
+      def integrate_sections
+        @report_fields.collect do |field_name, field_attrs|
+          section = ReportGenerator.build(ReportGenerator::Models::Section, field_attrs[:section])
+          records = section.perform
+          records.collect do |record|
+            r = {}.tap do |x|
+              x[:init_fields] = gen_initialize_fields(field_name, record)
+              field_name.each{|fn| x[fn] = record.send(@fields_maps[field_name][fn])}
+            end
+          end
+        end.flatten
+      end
+
+      def save records
+        ActiveRecord::Base.transaction do
+          records.each do |init_fields, record_attrs|
+            r = report_class.find_or_initialize_by(init_fields)
+            record_attrs.each{|k,v| r.send("#{k}=",v) }
+            r.save
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/report_generator/models/report_field.rb

@@ -0,0 +1,7 @@
+module ReportGenerator
+  module Models
+    class ReportField
+      attr_accessor :name, :section, :section_columns
+    end
+  end
+end

data/lib/report_generator/models/section.rb

@@ -0,0 +1,38 @@
+module ReportGenerator
+  module Models
+    class Section
+      include ReportGenerator::Helpers::QueryBuilder
+      attr_accessor :name, :data_source, :select_columns, :joins, :conditions, :group_columns, :sum_groups
+
+      def perform
+        p "current_section: #{name}"
+        records = query(data_source, select_columns, joins, conditions, group_columns)
+        if sum_groups.present?
+          sum_records = sum_groups.collect do |sum_col, distributer|
+            tmp_sum_col = sum_col.to_s.split('.').last
+            sum_group_items = distributer.distribute(records.map(&tmp_sum_col.to_sym).uniq.compact)
+            tmp_group_columns,tmp_select_columns = group_columns.dup, select_columns.dup
+            tmp_group_columns.delete(sum_col)
+            tmp_select_columns.delete(sum_col)
+            sum_group_items.collect do |sum_group_item|
+              tmp_conditions = []
+              tmp_conditions = conditions.dup
+              group_name = sum_group_item.shift
+              tmp_conditions << {sum_col => sum_group_item} if sum_group_item.compact.present?
+              result = query(data_source, tmp_select_columns, joins, tmp_conditions,tmp_group_columns)
+              result.tap do |x|
+                x.collect! do|r|
+                  tmp_attrs = r.attributes.dup
+                  tmp_attrs[tmp_sum_col] = group_name
+                  OpenStruct.new(tmp_attrs)
+                end
+              end
+            end # group_items
+          end # sum_groups
+          records += sum_records.flatten
+        end
+        records
+      end
+    end
+  end
+end

data/lib/report_generator/version.rb

@@ -0,0 +1,3 @@
+module ReportGenerator
+  VERSION = "1.0.0.beta1"
+end

data/lib/report_generator.rb

@@ -0,0 +1,58 @@
+require 'ostruct'
+
+require 'report_generator/helpers/query_builder'
+require 'report_generator/factories/attrs_factory'
+require 'report_generator/factories/report_field_factory'
+require 'report_generator/factories/section_factory'
+require 'report_generator/factories/report_factory'
+require 'report_generator/definers/section_definer'
+require 'report_generator/definers/report_definer'
+require 'report_generator/models/report'
+require 'report_generator/models/report_field'
+require 'report_generator/models/section'
+require 'report_generator/version'
+
+module ReportGenerator
+  @factories = {
+    ReportGenerator::Models::Section => {},
+    ReportGenerator::Models::Report => {}
+  }
+  class << self
+    def section_factories
+      @factories[ReportGenerator::Models::Section]
+    end
+
+    def report_factories
+      @factories[ReportGenerator::Models::Report]
+    end
+
+    def configure &block
+      class_eval(&block) if block_given?
+    end
+
+    def define_section &block
+      section_definer = ReportGenerator::Definers::SectionDefiner.new
+      section_definer.instance_eval(&block) if block_given?
+    end
+
+    def define_report &block
+      generator_definer = ReportGenerator::Definers::ReportDefiner.new
+      generator_definer.instance_eval(&block) if block_given?
+    end
+
+    def build model_class, name, attributes = {}
+      tmp_factory_attributes = @factories[model_class][name].attributes
+      if attributes.present?
+        tmp_factory_attributes.merge!(attributes)
+      end
+      tmp_model = model_class.new
+      tmp_model.tap do |x|
+        x.name = name
+        tmp_factory_attributes.each do |k,v|
+          x.send("#{k}=", v)
+        end
+      end
+    end
+
+  end
+end

data/report_generator.gemspec

@@ -0,0 +1,23 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'report_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "report_generator"
+  spec.version       = ReportGenerator::VERSION
+  spec.authors       = ["Evan Chiu"]
+  spec.email         = ["bjevanchiu@gmail.com"]
+  spec.description   = %q{A simple Ruby Internal DSL for creating Count Report which save data from MySQL to MySQL.}
+  spec.summary       = %q{A simple Ruby Internal DSL for creating Count Report which save data from MySQL to MySQL.}
+  spec.homepage      = "https://github.com/bjevanchiu/report_generator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: report_generator
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta1
+platform: ruby
+authors:
+- Evan Chiu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple Ruby Internal DSL for creating Count Report which save data
+  from MySQL to MySQL.
+email:
+- bjevanchiu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- lib/report_generator.rb
+- lib/report_generator/definers/report_definer.rb
+- lib/report_generator/definers/section_definer.rb
+- lib/report_generator/factories/attrs_factory.rb
+- lib/report_generator/factories/report_factory.rb
+- lib/report_generator/factories/report_field_factory.rb
+- lib/report_generator/factories/section_factory.rb
+- lib/report_generator/helpers/query_builder.rb
+- lib/report_generator/models/report.rb
+- lib/report_generator/models/report_field.rb
+- lib/report_generator/models/section.rb
+- lib/report_generator/version.rb
+- report_generator.gemspec
+homepage: https://github.com/bjevanchiu/report_generator
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A simple Ruby Internal DSL for creating Count Report which save data from
+  MySQL to MySQL.
+test_files: []