timescaledb 0.1.2 → 0.2.0

data/{timescale.gemspec → timescaledb.gemspec}

@@ -1,14 +1,14 @@
-require_relative 'lib/timescale/version'
+require_relative 'lib/timescaledb/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "timescaledb"
-  spec.version       = Timescale::VERSION
+  spec.version       = Timescaledb::VERSION
   spec.authors       = ["Jônatas Davi Paganini"]
   spec.email         = ["jonatasdp@gmail.com"]
 
   spec.summary       = %q{TimescaleDB helpers for Ruby ecosystem.}
   spec.description   = %q{Functions from timescaledb available in the ActiveRecord models.}
-  spec.homepage      = "https://github.com/jonatas/timescale"
+  spec.homepage      = "https://github.com/jonatas/timescaledb"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
@@ -27,12 +27,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/tsdb}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency  "pg", "~> 1.2"
+  spec.add_dependency "pg", "~> 1.2"
   spec.add_dependency "activerecord"
+  spec.add_dependency "activesupport"
 
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rspec-its"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "dotenv"
   spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "database_cleaner-active_record"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timescaledb
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Jônatas Davi Paganini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-02 00:00:00.000000000 Z
+date: 2022-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  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: Functions from timescaledb available in the ActiveRecord models.
 email:
 - jonatasdp@gmail.com
@@ -118,37 +146,95 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
+- ".tool-versions"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- Gemfile.scenic
+- Gemfile.scenic.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - bin/tsdb
-- examples/Gemfile
-- examples/Gemfile.lock
-- examples/all_in_one.rb
-- lib/timescale.rb
-- lib/timescale/acts_as_hypertable.rb
-- lib/timescale/chunk.rb
-- lib/timescale/compression_settings.rb
-- lib/timescale/continuous_aggregates.rb
-- lib/timescale/hypertable.rb
-- lib/timescale/job.rb
-- lib/timescale/job_stats.rb
-- lib/timescale/migration_helpers.rb
-- lib/timescale/stats_report.rb
-- lib/timescale/version.rb
-- timescale.gemspec
-homepage: https://github.com/jonatas/timescale
+- examples/all_in_one/Gemfile
+- examples/all_in_one/Gemfile.lock
+- examples/all_in_one/all_in_one.rb
+- examples/ranking/.gitattributes
+- examples/ranking/.gitignore
+- examples/ranking/.ruby-version
+- examples/ranking/Gemfile
+- examples/ranking/Gemfile.lock
+- examples/ranking/README.md
+- examples/ranking/Rakefile
+- examples/ranking/app/controllers/application_controller.rb
+- examples/ranking/app/controllers/concerns/.keep
+- examples/ranking/app/jobs/application_job.rb
+- examples/ranking/app/models/application_record.rb
+- examples/ranking/app/models/concerns/.keep
+- examples/ranking/app/models/game.rb
+- examples/ranking/app/models/play.rb
+- examples/ranking/bin/bundle
+- examples/ranking/bin/rails
+- examples/ranking/bin/rake
+- examples/ranking/bin/setup
+- examples/ranking/config.ru
+- examples/ranking/config/application.rb
+- examples/ranking/config/boot.rb
+- examples/ranking/config/credentials.yml.enc
+- examples/ranking/config/database.yml
+- examples/ranking/config/environment.rb
+- examples/ranking/config/environments/development.rb
+- examples/ranking/config/environments/production.rb
+- examples/ranking/config/environments/test.rb
+- examples/ranking/config/initializers/cors.rb
+- examples/ranking/config/initializers/filter_parameter_logging.rb
+- examples/ranking/config/initializers/inflections.rb
+- examples/ranking/config/initializers/timescale.rb
+- examples/ranking/config/locales/en.yml
+- examples/ranking/config/puma.rb
+- examples/ranking/config/routes.rb
+- examples/ranking/config/storage.yml
+- examples/ranking/db/migrate/20220209120747_create_games.rb
+- examples/ranking/db/migrate/20220209120910_create_plays.rb
+- examples/ranking/db/migrate/20220209143347_create_score_per_hours.rb
+- examples/ranking/db/schema.rb
+- examples/ranking/db/seeds.rb
+- examples/ranking/db/views/score_per_hours_v01.sql
+- examples/ranking/lib/tasks/.keep
+- examples/ranking/log/.keep
+- examples/ranking/public/robots.txt
+- examples/ranking/storage/.keep
+- examples/ranking/tmp/.keep
+- examples/ranking/tmp/pids/.keep
+- examples/ranking/tmp/storage/.keep
+- examples/ranking/vendor/.keep
+- lib/timescaledb.rb
+- lib/timescaledb/acts_as_hypertable.rb
+- lib/timescaledb/acts_as_hypertable/core.rb
+- lib/timescaledb/chunk.rb
+- lib/timescaledb/compression_settings.rb
+- lib/timescaledb/continuous_aggregates.rb
+- lib/timescaledb/dimensions.rb
+- lib/timescaledb/hypertable.rb
+- lib/timescaledb/job.rb
+- lib/timescaledb/job_stats.rb
+- lib/timescaledb/migration_helpers.rb
+- lib/timescaledb/scenic/adapter.rb
+- lib/timescaledb/scenic/extension.rb
+- lib/timescaledb/schema_dumper.rb
+- lib/timescaledb/stats_report.rb
+- lib/timescaledb/version.rb
+- timescaledb.gemspec
+homepage: https://github.com/jonatas/timescaledb
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/jonatas/timescale
+  homepage_uri: https://github.com/jonatas/timescaledb
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -164,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: TimescaleDB helpers for Ruby ecosystem.

data/lib/timescale/acts_as_hypertable.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-module Timescale
-  # If you want your model to hook into its underlying hypertable
-  # as well as have access to TimescaleDB specific data, methods, and more,
-  # specify this macro in your model.
-  #
-  # @note Your model's table needs to have already been converted to a hypertable
-  # via the TimescaleDB `create_hypertable` function for this to work.
-  #
-  # @see https://docs.timescale.com/api/latest/hypertable/create_hypertable/ for
-  #   how to use the SQL `create_hypertable` function.
-  # @see Timescale::MigrationHelpers#create_table for how to create a new hypertable
-  # via a Rails migration utilizing the standard `create_table` method.
-  #
-  # @example Enabling the macro on your model
-  #   class Event < ActiveRecord::Base
-  #     acts_as_hypertable
-  #   end
-  #
-  # @see Timescale::ActsAsHypertable::ClassMethods#acts_as_hypertable
-  #   for configuration options
-  module ActsAsHypertable
-    extend ActiveSupport::Concern
-
-    DEFAULT_OPTIONS = {
-      time_column: :created_at
-    }.freeze
-
-    module ClassMethods
-      # == Configuration options
-      #
-      # @param [Hash] options The options to initialize your macro with.
-      # @option options [Symbol] :time_column The name of the column in your
-      #   model's table containing time values. The name provided should be
-      #   the same name as the `time_column_name` you passed to the
-      #   TimescaleDB `create_hypertable` function.
-      #
-      # @example Enabling the macro on your model with options
-      #   class Event < ActiveRecord::Base
-      #     acts_as_hypertable time_column: :timestamp
-      #   end
-      #
-      def acts_as_hypertable(options = {})
-        return if already_declared_as_hypertable?
-
-        extend Timescale::ActsAsHypertable::HypertableClassMethods
-
-        class_attribute :hypertable_options, instance_writer: false
-
-        self.hypertable_options = DEFAULT_OPTIONS.dup
-        hypertable_options.merge!(options)
-        normalize_hypertable_options
-
-        define_association_scopes
-        define_default_scopes
-      end
-
-      def define_association_scopes
-        scope :chunks, -> do
-          Chunk.where(hypertable_name: table_name)
-        end
-
-        scope :hypertable, -> do
-          Hypertable.find_by(hypertable_name: table_name)
-        end
-
-        scope :jobs, -> do
-          Job.where(hypertable_name: table_name)
-        end
-
-        scope :job_stats, -> do
-          JobStats.where(hypertable_name: table_name)
-        end
-
-        scope :compression_settings, -> do
-          CompressionSettings.where(hypertable_name: table_name)
-        end
-
-        scope :continuous_aggregates, -> do
-          ContinuousAggregates.where(hypertable_name: table_name)
-        end
-      end
-
-      def define_default_scopes
-        scope :last_month, -> { where("#{time_column} > ?", 1.month.ago) }
-        scope :last_week, -> { where("#{time_column} > ?", 1.week.ago) }
-        scope :last_hour, -> { where("#{time_column} > ?", 1.hour.ago) }
-        scope :yesterday, -> { where("#{time_column} = ?", 1.day.ago.to_date) }
-        scope :today, -> { where("#{time_column} = ?", Date.today) }
-      end
-
-      private
-
-      def already_declared_as_hypertable?
-        singleton_class
-          .included_modules
-          .include?(Timescale::ActsAsHypertable::HypertableClassMethods)
-      end
-    end
-
-    module HypertableClassMethods
-      def time_column
-        @hypertable_time_column ||= hypertable_options[:time_column] || :created_at
-      end
-
-      protected
-
-      def normalize_hypertable_options
-        hypertable_options[:time_column] = hypertable_options[:time_column].to_sym
-      end
-    end
-  end
-end

data/lib/timescale/continuous_aggregates.rb

@@ -1,9 +0,0 @@
-module Timescale
-  class ContinuousAggregates < ActiveRecord::Base
-    self.table_name = "timescaledb_information.continuous_aggregates"
-    self.primary_key = 'materialization_hypertable_name'
-
-    has_many :jobs, foreign_key: "hypertable_name",
-      class_name: "Timescale::Job"
-  end
-end

data/lib/timescale/job.rb

@@ -1,13 +0,0 @@
-module Timescale
-  class Job < ActiveRecord::Base
-    self.table_name = "timescaledb_information.jobs"
-    self.primary_key = "job_id"
-
-    attribute :schedule_interval, :interval
-    attribute :max_runtime, :interval
-    attribute :retry_period, :interval
-
-    scope :compression, -> { where(proc_name: "tsbs_compress_chunks") }
-    scope :scheduled, -> { where(scheduled: true) }
-  end
-end

data/lib/timescale/stats_report.rb

@@ -1,28 +0,0 @@
-require "active_support/core_ext/numeric/conversions"
-module Timescale
-  module StatsReport
-    module_function
-    def resume
-      {
-        hypertables: {
-          count: Hypertable.count,
-          uncompressed: Hypertable.all.to_a.count { |h| h.compression_stats.empty? },
-          approximate_row_count: Hypertable.all.to_a.map do |hypertable|
-              { hypertable.hypertable_name => hypertable.approximate_row_count }
-            end.inject(&:merge!),
-          chunks: {
-            total: Chunk.count,
-            compressed: Chunk.compressed.count,
-            uncompressed: Chunk.uncompressed.count
-          },
-          size: {
-            before_compressing: Hypertable.all.map{|h|h.before_total_bytes}.inject(:+).to_s(:human_size),
-            after_compressing: Hypertable.all.map{|h|h.after_total_bytes}.inject(:+).to_s(:human_size)
-          }
-        },
-        continuous_aggregates: { count: ContinuousAggregates.count },
-        jobs_stats: JobStats.resume
-      }
-    end
-  end
-end

data/lib/timescale/version.rb

@@ -1,3 +0,0 @@
-module Timescale
-  VERSION = '0.1.2'
-end

data/lib/timescale.rb

@@ -1,52 +0,0 @@
-require 'active_record'
-
-require_relative 'timescale/acts_as_hypertable'
-require_relative 'timescale/chunk'
-require_relative 'timescale/compression_settings'
-require_relative 'timescale/continuous_aggregates'
-require_relative 'timescale/hypertable'
-require_relative 'timescale/job'
-require_relative 'timescale/job_stats'
-require_relative 'timescale/stats_report'
-require_relative 'timescale/migration_helpers'
-require_relative 'timescale/version'
-
-module Timescale
-  module_function
-
-  def chunks
-    Chunk.all
-  end
-
-  def hypertables
-    Hypertable.all
-  end
-
-  def continuous_aggregates
-    ContinuousAggregates.all
-  end
-
-  def compression_settings
-    CompressionSettings.all
-  end
-
-  def jobs
-    Job.all
-  end
-
-  def job_stats
-    JobStats.all
-  end
-
-  def show_stats
-    StatsReport.resume
-  end
-
-  def default_hypertable_options
-    Timescale::ActsAsHypertable::DEFAULT_OPTIONS
-  end
-end
-
-ActiveSupport.on_load :active_record do
-  include Timescale::ActsAsHypertable
-end