rails_timeseries 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74293924cccbcada4fd5c93f35ac966a5e656384
+  data.tar.gz: 391e29617edf9760c26f4f5103768473a7972fbb
+SHA512:
+  metadata.gz: 330ab655f44149107c2578acca912ea15d2bf754b4423eaae59a8619c9f70b5eecda4248bf6631fe83c869427b5d25bd41f0154500b0d67157d5632a3fded914
+  data.tar.gz: 69c5827010ff7542d470e40ce99aabe973edc8506cc81c8e558dd1237aa1cc3ae791d925bf8b76dcc6e76f593d917cad18de457d39edadd358edf2848dc9a2e7

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at yuzong@naver.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rails_timeseries.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 JonghunYu
+
+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,73 @@
+# RailsTimeseries
+RailsTimeseries is a gem that generates time series data and store in the database. You can select data by defining scope and the data collected will be used for statistics, drawing a chart
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_timeseries'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_timeseries
+
+And to install templates:
+
+    $ rails g rails_timeseries:install
+
+And db migation:
+
+    $ rails db:migrate
+
+
+## Usage
+### Define a scope
+```ruby
+class User < ApplicationRecord
+  include RailsTimeseries
+  timeseries_scope :active_users do
+    where("current_sign_in_at > ?", 1.days.ago)
+  end
+end
+```
+and you can collect number of active_users in every day or every hours
+
+### Set time frame
+RailsTimeseries uses [whenever](https://github.com/javan/whenever) gem to run data collect job. you can change time frame by modifying `config/schedule.rb` file that is generated during installation.
+```ruby
+# it collects data in every 5AM
+every :day, at: '5:00am' do
+  runner "Timeseries.generate"
+end
+```
+
+### Retrive datas
+``` ruby
+Timeseries.data(:active_users)
+#this will return number of active_users with date
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 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/[USERNAME]/rails_timeseries. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RailsTimeseries project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rails_timeseries/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_timeseries"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/rails_timeseries/install/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators/active_record'
+
+module RailsTimeseries
+  module Generators
+    class InstallGenerator < ActiveRecord::Generators::Base
+      desc 'install RailsTimeseries templates'
+      argument :name, type: :string, default: ""
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_templates
+        migration_template 'create_timeseries.rb', 'db/migrate/create_timeseries.rb'
+        template 'timeseries.rb', 'app/models/timeseries.rb'
+        template 'schedule.rb', 'config/schedule.rb'
+      end
+    end
+  end
+end

data/lib/generators/rails_timeseries/install/templates/create_timeseries.rb

@@ -0,0 +1,10 @@
+class CreateTimeseries < ActiveRecord::Migration<%="[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"%>
+  def change
+    create_table :timeseries do |t|
+      t.date      "date", null: false, index: true
+      t.string    "scope", null: false, index: true
+      t.integer   "count", null: false
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/rails_timeseries/install/templates/schedule.rb

@@ -0,0 +1,18 @@
+# Use this file to easily define all of your cron jobs.
+#
+# It's helpful, but not entirely necessary to understand cron before proceeding.
+# http://en.wikipedia.org/wiki/Cron
+
+# Example:
+#
+# set :output, "/some_log_path/cron_log.log"
+
+every :day, at: '5:00am' do
+  runner "Timeseries.generate"
+end
+
+# every 4.days do
+#   runner "AnotherModel.prune_old_records"
+# end
+
+# Learn more: http://github.com/javan/whenever

data/lib/generators/rails_timeseries/install/templates/timeseries.rb

@@ -0,0 +1,22 @@
+class Timeseries < ActiveRecord::Base
+  def self.generate
+    ActiveRecord::Base.subclasses.each do |model|
+      next unless model.respond_to?(:timeseries_scopes)
+      model.send(:timeseries_scopes).each do |scope|
+        timeseries = Timeseries.find_or_initialize_by(date: Time.now.to_date, scope: scope.to_s)
+        timeseries.count = model.send(scope).count
+        timeseries.save
+      end
+    end
+    return
+  end
+
+  def self.data(scope, options = {})
+    options.symbolize_keys!
+    data = where(scope: scope)
+    data = data.where('date > ?', options[:start_date]) if options[:start_date]
+    data = data.where('date < ?', options[:end_date]) if options[:end_date]
+    data = data.order(:date).pluck(:date, :count)
+    Hash[data]
+  end
+end

data/lib/rails_timeseries/version.rb

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

data/lib/rails_timeseries.rb

@@ -0,0 +1,17 @@
+require "rails_timeseries/version"
+require "rails"
+
+module RailsTimeseries
+  extend ActiveSupport::Concern
+  included do
+    cattr_accessor :timeseries_scopes
+  end
+
+  class_methods do
+    def timeseries_scope(name, &block)
+      self.timeseries_scopes ||= []
+      self.timeseries_scopes << name
+      define_singleton_method name, block
+    end
+  end
+end

data/rails_timeseries.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails_timeseries/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_timeseries"
+  spec.version       = RailsTimeseries::VERSION
+  spec.authors       = ["JonghunYu"]
+  spec.email         = ["yuzong@naver.com"]
+
+  spec.summary       = %q{rails gem generating time series data of active records}
+  spec.description   = %q{rails gem generating time series data of active records. This is useful when you need a chart for number of active users or transactions}
+  spec.homepage      = "https://github.com/nerdyfactory/rails_timeseries"
+  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_dependency "rails", "~> 5.0"
+  spec.add_dependency "whenever"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec-activemodel-mocks"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: rails_timeseries
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- JonghunYu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: whenever
+  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: 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: rspec-activemodel-mocks
+  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-rails
+  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: pry
+  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: rails gem generating time series data of active records. This is useful
+  when you need a chart for number of active users or transactions
+email:
+- yuzong@naver.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/rails_timeseries/install/install_generator.rb
+- lib/generators/rails_timeseries/install/templates/create_timeseries.rb
+- lib/generators/rails_timeseries/install/templates/schedule.rb
+- lib/generators/rails_timeseries/install/templates/timeseries.rb
+- lib/rails_timeseries.rb
+- lib/rails_timeseries/version.rb
+- rails_timeseries.gemspec
+homepage: https://github.com/nerdyfactory/rails_timeseries
+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.11
+signing_key: 
+specification_version: 4
+summary: rails gem generating time series data of active records
+test_files: []