chartable 0.0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 542726255882a8805df4e6f6fdd0417234dea2841340b1e0c703729c40c9355f
+  data.tar.gz: 38f0a30b7f1dc584968a268a8eed9c042788aedd285b98b2fc6b336ef43b27b4
+SHA512:
+  metadata.gz: 3364382cc913e5e98ed6bc7aae962cfd261639241fceb709e9f5e583a32f2e913a99d9921cafb2234034ff80eb027e1025988e2877e7b86362eb0c48aeb1bb71
+  data.tar.gz: f95d5ae606a9cde926d3242bb7cf2d46736fe80260285e3e57b5d078fee8fba6f0a7cf5e5abea56d318906625e2668394b71f47770dc6c4716c557bb97ce1da7

data/lib/chartable.rb

@@ -0,0 +1,9 @@
+require 'chartable/errors/invalid_period_error'
+require 'chartable/queries/daily'
+require 'chartable/queries/monthly'
+require 'chartable/queries/weekly'
+require 'chartable/queries/quarterly'
+require 'chartable/queries/yearly'
+require 'chartable/active_record_extension'
+require 'chartable/period_query'
+require 'chartable/range_query'

data/lib/chartable/active_record_extension.rb

@@ -0,0 +1,21 @@
+require 'active_support'
+require 'active_record'
+
+module Chartable
+  module ActiveRecordExtension
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # It returns analytics hash created from the given criteria
+      #
+      # @return [Hash]
+      def analytics(period, from: nil, to: nil, on: 'created_at')
+        period_query = Chartable::PeriodQuery.build(period)
+        scope = Chartable::RangeQuery.call(self, on: on, from: from, to: to)
+        period_query.call(scope, on: on)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, Chartable::ActiveRecordExtension)

data/lib/chartable/errors/invalid_period_error.rb

@@ -0,0 +1,5 @@
+module Chartable
+  module Errors
+    class InvalidPeriodError < StandardError; end
+  end
+end

data/lib/chartable/period_query.rb

@@ -0,0 +1,23 @@
+module Chartable
+  class PeriodQuery
+    PERIODS = {
+      daily: Chartable::Queries::Daily,
+      weekly: Chartable::Queries::Weekly,
+      quarterly: Chartable::Queries::Quarterly,
+      yearly: Chartable::Queries::Yearly,
+      monthly: Chartable::Queries::Monthly
+    }
+
+    # It returns the proper query object for selected period.
+    # If given period is not supported it raises `Chartable::Errors::InvalidPeriodError` error
+    #
+    # @return [Class]
+    def self.build(period)
+      period_class = PERIODS[period]
+
+      raise(Chartable::Errors::InvalidPeriodError, "#{period} is not valid, valid one are: #{PERIODS.keys.join(', ')}") if period_class.nil?
+
+      period_class
+    end
+  end
+end

data/lib/chartable/queries/daily.rb

@@ -0,0 +1,13 @@
+module Chartable
+  module Queries
+    class Daily
+      # It returns analytics data for the daily period.
+      # Example output: `{"October 09, 2018" => 1, "October 10, 2018" => 1}`
+      #
+      # @return [Hash]
+      def self.call(scope, on:)
+        scope.group("DATE_FORMAT(#{on}, '%M %d, %Y')").size
+      end
+    end
+  end
+end

data/lib/chartable/queries/monthly.rb

@@ -0,0 +1,13 @@
+module Chartable
+  module Queries
+    class Monthly
+      # It returns analytics data for the monthly period.
+      # Example output: `{"November 2018" => 1, "October 2018" => 1}`
+      #
+      # @return [Hash]
+      def self.call(scope, on:)
+        scope.group("DATE_FORMAT(#{on},'%M %Y')").size
+      end
+    end
+  end
+end

data/lib/chartable/queries/quarterly.rb

@@ -0,0 +1,13 @@
+module Chartable
+  module Queries
+    class Quarterly
+      # It returns analytics data for the quarterly period.
+      # Example output: `{"Q1 2018" => 1, "Q2 2018" => 1}`
+      #
+      # @return [Hash]
+      def self.call(scope, on:)
+        scope.group("CONCAT('Q', QUARTER(#{on}), DATE_FORMAT(#{on},' %Y'))").size
+      end
+    end
+  end
+end

data/lib/chartable/queries/weekly.rb

@@ -0,0 +1,13 @@
+module Chartable
+  module Queries
+    class Weekly
+      # It returns analytics data for the weekly period.
+      # Example output: `{"01/28/18 - 02/03/18" => 1, "02/11/18 - 02/17/18" => 1}`
+      #
+      # @return [Hash]
+      def self.call(scope, on:)
+        scope.group("CONCAT(DATE_FORMAT(DATE(DATE_ADD(#{on}, INTERVAL(1-DAYOFWEEK(#{on})) DAY)), '%m/%d/%y'), ' - ', DATE_FORMAT(DATE(DATE_ADD(#{on}, INTERVAL(7-DAYOFWEEK(#{on})) DAY)),'%m/%d/%y'))").size
+      end
+    end
+  end
+end

data/lib/chartable/queries/yearly.rb

@@ -0,0 +1,13 @@
+module Chartable
+  module Queries
+    class Yearly
+      # It returns analytics data for the yearly period.
+      # Example output: `{ 2017 => 1, 2018 => 1 }`
+      #
+      # @return [Hash]
+      def self.call(scope, on:)
+        scope.group("YEAR(#{on})").size
+      end
+    end
+  end
+end

data/lib/chartable/range_query.rb

@@ -0,0 +1,25 @@
+require 'chronic'
+
+module Chartable
+  class RangeQuery
+    # Returns scope filtered according to the given date criteria.
+    # If dates are not given it returns original scope.
+    # Given value is parsed by Chronic gem and transformed into the data format
+    #
+    # @return [Model::ActiveRecord_Relation]
+    def self.call(scope, on:, from: nil, to: nil)
+      from_date = Chronic.parse(from)
+      to_date = Chronic.parse(to)
+
+      return scope if from_date.nil? && to_date.nil?
+
+      if from_date.nil?
+        scope.where("DATE(#{on}) <= ?", to_date.to_date)
+      elsif to_date.nil?
+        scope.where("DATE(#{on}) >= ?", from_date.to_date)
+      else
+        scope.where("DATE(#{on}) >= ? AND DATE(#{on}) <= ?", from_date.to_date, to_date.to_date)
+      end
+    end
+  end
+end

data/lib/chartable/version.rb

@@ -0,0 +1,12 @@
+module Chartable
+  module Version
+    module_function
+
+    # Gem current version
+    #
+    # @return [String]
+    def to_s
+      "0.0.0.1"
+    end
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: chartable
+version: !ruby/object:Gem::Version
+  version: 0.0.0.1
+platform: ruby
+authors:
+- Paweł Dąbrowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.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: 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'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: A lightweight and database-level library to transform any Active Record
+  query into analytics data ready for any chart
+email: dziamber@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/chartable.rb
+- lib/chartable/active_record_extension.rb
+- lib/chartable/errors/invalid_period_error.rb
+- lib/chartable/period_query.rb
+- lib/chartable/queries/daily.rb
+- lib/chartable/queries/monthly.rb
+- lib/chartable/queries/quarterly.rb
+- lib/chartable/queries/weekly.rb
+- lib/chartable/queries/yearly.rb
+- lib/chartable/range_query.rb
+- lib/chartable/version.rb
+homepage: http://github.com/rubyhero/chartable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: A lightweight and database-level library to transform any Active Record query
+  into analytics data ready for any chart
+test_files: []