double_entry-reporting 0.1.0

data/lib/double_entry/reporting/time_range_array.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+module DoubleEntry
+  module Reporting
+    class TimeRangeArray
+      attr_reader :type, :require_start
+      alias_method :require_start?, :require_start
+
+      def initialize(options = {})
+        @type = options[:type]
+        @require_start = options[:require_start]
+      end
+
+      def make(start = nil, finish = nil)
+        start = start_range(start)
+        finish = finish_range(finish)
+        [start].tap do |array|
+          while start != finish
+            start = start.next
+            array << start
+          end
+        end
+      end
+
+      def start_range(start = nil)
+        fail 'Must specify start of range' if start.blank? && require_start?
+        start_time = start ? Time.parse(start) : Reporting.configuration.start_of_business
+        type.from_time(start_time)
+      end
+
+      def finish_range(finish = nil)
+        finish ? type.from_time(Time.parse(finish)) : type.current
+      end
+
+      FACTORIES = {
+        'hour'  => new(:type => HourRange,  :require_start => true),
+        'day'   => new(:type => DayRange,   :require_start => true),
+        'week'  => new(:type => WeekRange,  :require_start => true),
+        'month' => new(:type => MonthRange, :require_start => false),
+        'year'  => new(:type => YearRange,  :require_start => false),
+      }
+
+      def self.make(range_type, start = nil, finish = nil)
+        factory = FACTORIES[range_type]
+        fail ArgumentError, "Invalid range type '#{range_type}'" unless factory
+        factory.make(start, finish)
+      end
+    end
+  end
+end

data/lib/double_entry/reporting/version.rb

@@ -0,0 +1,5 @@
+module DoubleEntry
+  module Reporting
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/double_entry/reporting/week_range.rb

@@ -0,0 +1,107 @@
+# encoding: utf-8
+module DoubleEntry
+  module Reporting
+    # We use a particularly crazy week numbering system: week 1 of any given year
+    # is the first week with any days that fall into that year.
+    #
+    # So, for example, week 1 of 2011 starts on 27 Dec 2010.
+    class WeekRange < TimeRange
+      class << self
+        def from_time(time)
+          date = time.to_date
+          week = date.cweek
+          year = date.end_of_week.year
+
+          if date.beginning_of_week.year != year
+            week = 1
+          elsif date.beginning_of_year.cwday > Date::DAYNAMES.index('Thursday')
+            week += 1
+          end
+
+          new(:year => year, :week => week)
+        end
+
+        def current
+          from_time(Time.now)
+        end
+
+        # Obtain a sequence of WeekRanges from the given start to the current
+        # week.
+        #
+        # @option options :from [Time] Time of the first in the returned sequence
+        #   of WeekRanges.
+        # @return [Array<WeekRange>]
+        def reportable_weeks(options = {})
+          week = options[:from] ? from_time(options[:from]) : earliest_week
+          last_in_sequence = current
+          [week].tap do |weeks|
+            while week != last_in_sequence
+              week = week.next
+              weeks << week
+            end
+          end
+        end
+
+      private
+
+        def start_of_year(year)
+          Time.local(year, 1, 1).beginning_of_week
+        end
+
+        def earliest_week
+          from_time(Reporting.configuration.start_of_business)
+        end
+      end
+
+      attr_reader :year, :week
+
+      def initialize(options = {})
+        super options
+
+        if options.present?
+          @week = options[:week]
+
+          @start  = week_and_year_to_time(@week, @year)
+          @finish = @start.end_of_week
+
+          @start = earliest_week.start if options[:range_type] == :all_time
+        end
+      end
+
+      def previous
+        from_time(@start - 1.week)
+      end
+
+      def next
+        from_time(@start + 1.week)
+      end
+
+      def ==(other)
+        week == other.week &&
+          year == other.year
+      end
+
+      def all_time
+        self.class.new(:year => year, :week => week, :range_type => :all_time)
+      end
+
+      def to_s
+        "#{year}, Week #{week}"
+      end
+
+    private
+
+      def from_time(time)
+        self.class.from_time(time)
+      end
+
+      def earliest_week
+        self.class.send(:earliest_week)
+      end
+
+      def week_and_year_to_time(week, year)
+        self.class.send(:start_of_year, year) + (week - 1).weeks
+      end
+    end
+  end
+end

data/lib/double_entry/reporting/year_range.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+module DoubleEntry
+  module Reporting
+    class YearRange < TimeRange
+      attr_reader :year
+
+      def initialize(options)
+        super options
+
+        year_start = Time.local(@year, 1, 1)
+        @start = year_start
+        @finish = year_start.end_of_year
+      end
+
+      def self.current
+        new(:year => Time.now.year)
+      end
+
+      def self.from_time(time)
+        new(:year => time.year)
+      end
+
+      def ==(other)
+        year == other.year
+      end
+
+      def previous
+        YearRange.new(:year => year - 1)
+      end
+
+      def next
+        YearRange.new(:year => year + 1)
+      end
+
+      def to_s
+        year.to_s
+      end
+    end
+  end
+end

data/lib/generators/double_entry/reporting/install/install_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module DoubleEntry
+  module Reporting
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        include Rails::Generators::Migration
+
+        source_root File.expand_path('../templates', __FILE__)
+
+        def self.next_migration_number(path)
+          ActiveRecord::Generators::Base.next_migration_number(path)
+        end
+
+        def copy_migrations
+          migration_template 'migration.rb', 'db/migrate/create_double_entry_reporting_tables.rb', migration_version: migration_version
+        end
+
+        def migration_version
+          if ActiveRecord.version.version > '5'
+            "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/double_entry/reporting/install/templates/migration.rb

@@ -0,0 +1,25 @@
+class CreateDoubleEntryReportingTables < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+    create_table "double_entry_line_aggregates", :force => true do |t|
+      t.string     "function",   :limit => 15, :null => false
+      t.string     "account",                  :null => false
+      t.string     "code"
+      t.string     "partner_account"
+      t.string     "scope"
+      t.integer    "year"
+      t.integer    "month"
+      t.integer    "week"
+      t.integer    "day"
+      t.integer    "hour"
+      t.bigint     "amount",                   :null => false
+      t.string     "filter"
+      t.string     "range_type", :limit => 15, :null => false
+      t.timestamps                             :null => false
+    end
+    add_index "double_entry_line_aggregates", ["function", "account", "code", "partner_account", "year", "month", "week", "day"], :name => "line_aggregate_idx"
+  end
+
+  def self.down
+    drop_table "double_entry_line_aggregates"
+  end
+end

metadata

@@ -0,0 +1,290 @@
+--- !ruby/object:Gem::Specification
+name: double_entry-reporting
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Envato
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: double_entry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  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'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  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'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: 
+email:
+- rubygems@envato.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/double_entry/reporting.rb
+- lib/double_entry/reporting/aggregate.rb
+- lib/double_entry/reporting/aggregate_array.rb
+- lib/double_entry/reporting/day_range.rb
+- lib/double_entry/reporting/hour_range.rb
+- lib/double_entry/reporting/line_aggregate.rb
+- lib/double_entry/reporting/line_aggregate_filter.rb
+- lib/double_entry/reporting/line_metadata_filter.rb
+- lib/double_entry/reporting/month_range.rb
+- lib/double_entry/reporting/time_range.rb
+- lib/double_entry/reporting/time_range_array.rb
+- lib/double_entry/reporting/version.rb
+- lib/double_entry/reporting/week_range.rb
+- lib/double_entry/reporting/year_range.rb
+- lib/generators/double_entry/reporting/install/install_generator.rb
+- lib/generators/double_entry/reporting/install/templates/migration.rb
+homepage: https://github.com/envato/double_entry-reporting
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/envato/double_entry-reporting/issues
+  changelog_uri: https://github.com/envato/double_entry-reporting/blob/v0.1.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/double_entry-reporting/0.1.0
+  source_code_uri: https://github.com/envato/double_entry-reporting/tree/v0.1.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.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: Tools to build your double entry financial ledger
+test_files: []