redis-objects-periodical 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 61c703571cd2602ebeac975dcc983374517185014a74aacdd162aedb20ec1f19
+  data.tar.gz: 903c0e78b58e6a0f1db6476f11906e4a1212436d91db60c5cdbd9f5f65069b20
+SHA512:
+  metadata.gz: 0edcd884c0fa276c755e455e24b1727e903303a7b3ba90a0fe865d6acce22fd5de2fbd9312cb15a0fd5504925b6368bca981e98e5ff9871bc853330807e89fc1
+  data.tar.gz: dca107efe011fe1753861ce9a3471d8b18f923a779e5ffb3b8f499a388cc359500cb6d374814f0b4ee3605123052686d864486211d45c75b9813f1d4a36a0b45

data/.circleci/config.yml

@@ -0,0 +1,207 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2.1
+
+orbs:
+  ruby-orbs: sue445/ruby-orbs@1.6.2
+  code-climate: rvla/code-climate@0.0.2
+
+references:
+  - &ruby_version
+    ruby_version:
+      type: enum
+      enum: ["2.7", "3.0", "3.1"]
+      default: "3.1"
+
+executors:
+  default:
+    parameters:
+      <<: *ruby_version
+    docker:
+      - image: cimg/ruby:<< parameters.ruby_version >>
+      - image: redis:latest
+        name: redis
+    working_directory: ~/repo
+
+commands:
+  run_rspec:
+    description: "Run RSpec"
+    steps:
+      - run:
+          name: "Execute RSpec"
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+            cc-test-reporter before-build
+            bundle exec rspec --format documentation \
+                              --color \
+                              --format RspecJunitFormatter \
+                              --out /tmp/test-results/rspec.xml \
+                              $TEST_FILES
+      - code-climate/format-coverage:
+          input-type: simplecov
+          prefix: $(readlink -f .)
+          coverage-file: coverage/coverage.json
+          output: coverage/codeclimate.$CIRCLE_BUILD_NUM.json
+      - persist_to_workspace:
+          root: coverage
+          paths:
+            - codeclimate.*.json
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
+  rubocop:
+    steps:
+      - run:
+          name: Run RuboCop
+          command: bundle exec rubocop
+  yardoc:
+    description: "Generate YARDoc"
+    steps:
+      - run: bundle exec yardoc -o ./yardoc
+      - store_artifacts:
+          path: ./yardoc
+          destination: yardoc
+  rake_build:
+    steps:
+      - run:
+          name: Rake Build
+          command: bundle exec rake build
+  rubocop_challenge:
+    steps:
+      - run:
+          name: Rubocop Challenge
+          command: |
+            gem install rubocop_challenger
+            rubocop_challenger go --email=ryz310@gmail.com --name=ryz310
+  release:
+    description: Release to RubyGems.org
+    steps:
+      - run:
+          name: Create Rubygems Credentials
+          command: |
+            mkdir ~/.gem || true
+            echo -e "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}" > ~/.gem/credentials
+            chmod 0600 ~/.gem/credentials
+      - run:
+          name: Release Gem
+          command: |
+            git push --set-upstream origin ${CIRCLE_BRANCH}
+            bundle exec rake release --trace
+  setup:
+    description: Setup for Job Working
+    parameters:
+      <<: *ruby_version
+    steps:
+      - checkout
+      - ruby-orbs/bundle-install:
+          cache_key_prefix: v1-dependencies-<< parameters.ruby_version >>
+  test_and_build:
+    description: Build the RubyGem
+    steps:
+      - code-climate/install
+      - run_rspec
+      - rake_build
+
+jobs:
+  build:
+    parameters:
+      <<: *ruby_version
+    executor:
+      name: default
+      ruby_version: << parameters.ruby_version >>
+    steps:
+      - setup:
+          ruby_version: << parameters.ruby_version >>
+      - test_and_build
+  upload-coverage:
+    executor: default
+    steps:
+      - attach_workspace:
+          at: ~/repo
+      - code-climate/install
+      - code-climate/sum-coverage:
+          input: codeclimate.*.json
+          parts: 3
+      - code-climate/upload-coverage
+  rubocop:
+    parameters:
+      <<: *ruby_version
+    executor:
+      name: default
+      ruby_version: << parameters.ruby_version >>
+    steps:
+      - setup:
+          ruby_version: << parameters.ruby_version >>
+      - rubocop
+  yardoc:
+    executor: default
+    steps:
+      - setup
+      - yardoc
+  rubocop_challenge:
+    executor: default
+    steps:
+      - checkout
+      - rubocop_challenge
+  release:
+    executor: default
+    steps:
+      - setup
+      - release
+
+workflows:
+  version: 2
+
+  commit:
+    jobs:
+      - build:
+          name: build_on_ruby_2.7
+          ruby_version: "2.7"
+      - build:
+          name: build_on_ruby_3.0
+          ruby_version: "3.0"
+      - build:
+          name: build_on_ruby_3.1
+          ruby_version: "3.1"
+      - rubocop:
+          ruby_version: "2.7"
+      - yardoc
+      - upload-coverage:
+          requires:
+            - build_on_ruby_2.7
+            - build_on_ruby_3.0
+            - build_on_ruby_3.1
+      - release:
+          context: RubyGems API Key
+          requires:
+            - build_on_ruby_2.7
+            - build_on_ruby_3.0
+            - build_on_ruby_3.1
+            - rubocop
+          filters:
+            branches:
+              only:
+                - release
+
+  challenge:
+    triggers:
+      - schedule:
+          cron: "30 23 * * *" # 8:30am every day (JST)
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - rubocop_challenge
+
+experimental:
+  notify:
+    branches:
+      only:
+        - master
+        - release

data/.gem_comet.yml

@@ -0,0 +1,24 @@
+# [Usage]
+#
+# $ gem install gem_comet
+# $ gem_comet init
+# $ gem_comet release {version number, like as "1.2.3"}
+# $ gem_comet changelog
+# $ gem_comet versions
+
+version: 1.2
+
+release:
+  base_branch: master
+  release_branch: release
+  version_file_path: lib/redis/objects/periodical/version.rb
+  changelog_file_path: CHANGELOG.md # optional
+changelog:
+  categories:
+    - Feature
+    - Bugfix
+    - Security
+    - Breaking Change
+    - Rubocop Challenge
+    - Dependabot
+    - Misc

data/.github/dependabot.yml

@@ -0,0 +1,19 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "08:00"
+    timezone: Japan
+  open-pull-requests-limit: 10
+  reviewers:
+  - ryz310
+  assignees:
+  - ryz310
+  labels:
+  - dependabot
+  ignore:
+  - dependency-name: simplecov
+    versions:
+    - ">= 0.19.a, < 0.20"

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,40 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+    - "redis-objects-daily-counter.gemspec"
+    - "redis-objects-periodical.gemspec"
+
+Metrics/MethodLength:
+  Max: 15
+
+Naming/FileName:
+  Exclude:
+    - "lib/redis-objects-periodical.rb"
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/NestedGroups:
+  Max: 5
+
+RSpec/MultipleExpectations:
+  Max: 4

data/.rubocop_todo.yml

@@ -0,0 +1,16 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2021-09-23 07:31:02 UTC using RuboCop version 0.93.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 6
+# Configuration parameters: IgnoredMethods.
+Metrics/AbcSize:
+  Max: 21
+
+# Offense count: 41
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,112 @@
+# Change log
+
+## v0.4.0 (Jul 26, 2022)
+
+### Feature
+
+- [#17](https://github.com/ryz310/redis-object-periodical/pull/17) Support `Redis::HashKey` as a recurring object ([@ryz310](https://github.com/ryz310))
+
+### Breaking Change
+
+- [#18](https://github.com/ryz310/redis-object-periodical/pull/18) Bump up Ruby 3.1 and drop support Ruby 2.6 ([@ryz310](https://github.com/ryz310))
+
+### Dependabot
+
+- [#16](https://github.com/ryz310/redis-object-periodical/pull/16) Bump yard from 0.9.26 to 0.9.28 ([@ryz310](https://github.com/ryz310))
+- [#15](https://github.com/ryz310/redis-object-periodical/pull/15) Bump rspec_junit_formatter from 0.4.1 to 0.5.1 ([@ryz310](https://github.com/ryz310))
+- [#13](https://github.com/ryz310/redis-object-periodical/pull/13) Bump rspec from 3.10.0 to 3.11.0 ([@ryz310](https://github.com/ryz310))
+- [#14](https://github.com/ryz310/redis-object-periodical/pull/14) Bump timecop from 0.9.4 to 0.9.5 ([@ryz310](https://github.com/ryz310))
+- [#12](https://github.com/ryz310/redis-object-periodical/pull/12) Bump redis-objects from 1.5.1 to 1.7.0 ([@ryz310](https://github.com/ryz310))
+
+### Misc
+
+- [#19](https://github.com/ryz310/redis-object-periodical/pull/19) Reduce similar source codes with meta programming ([@ryz310](https://github.com/ryz310))
+
+## v0.3.0 (Sep 23, 2021)
+
+### Feature
+
+- [#7](https://github.com/ryz310/redis-object-periodical/pull/7) Add daily set ([@ryz310](https://github.com/ryz310))
+
+> You can use `daily_set` in addition to the standard features of Redis::Objects.
+>
+> ```rb
+> class Homepage
+>   include Redis::Objects
+>
+>   daily_set :dau, expireat: -> { Time.now + 2_678_400 } # about a month
+>
+>   def id
+>     1
+>   end
+> end
+>
+> # 2021-04-01
+> homepage.dau << 'user1'
+> homepage.dau << 'user2'
+> homepage.dau << 'user1' # dup ignored
+> puts homepage.dau.members # ['user1', 'user2']
+> puts homepage.dau.length # 2
+> puts homepage.dau.count # alias of #length
+>
+> # 2021-04-02 (next day)
+> puts homepage.dau.members # []
+> homepage.dau.merge('user2', 'user3')
+> puts homepage.dau.members # ['user2', 'user3']
+>
+> # 2021-04-03 (next day)
+> homepage.dau.merge('user4')
+>
+> homepage.dau[Date.new(2021, 4, 1)] # => ['user1', 'user2']
+> homepage.dau[Date.new(2021, 4, 1), 3] # => ['user1', 'user2', 'user3', 'user4']
+> homepage.dau[Date.new(2021, 4, 1)..Date.new(2021, 4, 2)] # => ['user1', 'user2', 'user3']
+>
+> homepage.dau.delete_at(Date.new(2021, 4, 1))
+> homepage.dau.range(Date.new(2021, 4, 1), Date.new(2021, 4, 3)) # => ['user2', 'user3', 'user4']
+> homepage.dau.at(Date.new(2021, 4, 2)) # => #<Redis::Set key="homepage:1:dau:2021-04-02">
+> homepage.dau.at(Date.new(2021, 4, 2)).members # ['user2', 'user3']
+> ```
+
+### Breaking Change
+
+- [#7](https://github.com/ryz310/redis-object-periodical/pull/7) Add daily set ([@ryz310](https://github.com/ryz310))
+
+> Rename the method from #delete to #delete_at a73251f
+>
+> ```rb
+> # Before
+> homepage.pv.delete(Date.new(2021, 4, 1))
+>
+> # After
+> homepage.pv.delete_at(Date.new(2021, 4, 1))
+> ```
+>
+> Modify returning value of RecurringAtIntervals#at 1c8cc79
+>
+> ```rb
+> # Before
+> homepage.pv.at(Date.new(2021, 4, 2)) # => 2
+>
+> # After
+> homepage.pv.at(Date.new(2021, 4, 2)) # => #<Redis::Counter key="homepage:1:pv:2021-04-02">
+> ```
+
+## v0.2.0 (Sep 20, 2021)
+
+### Feature
+
+- [#3](https://github.com/ryz310/redis-objects-periodical/pull/3) Support time zone ([@ryz310](https://github.com/ryz310))
+- [#4](https://github.com/ryz310/redis-objects-periodical/pull/4) Add daily counter family ([@ryz310](https://github.com/ryz310))
+  - `annual_counter`
+  - `monthly_counter`
+  - `weekly_counter`
+  - `hourly_counter`
+  - `minutely_counter`
+
+### Misc
+
+- [#2](https://github.com/ryz310/redis-objects-periodical/pull/2) Install circle ci ([@ryz310](https://github.com/ryz310))
+
+## v0.1.0 (Sep 12, 2021)
+
+- The first release :tada:

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at ryz310@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Dockerfile

@@ -0,0 +1,7 @@
+FROM ruby:2.7
+
+RUN mkdir /my_app
+WORKDIR /my_app
+COPY . /my_app
+
+RUN gem install bundler && bundle

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redis-objects-periodical.gemspec
+gemspec name: 'redis-objects-periodical'
+
+gem 'bundler', '>= 2.0'
+gem 'pry-byebug'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.11'
+gem 'rspec_junit_formatter'
+gem 'rubocop', '~> 0.80'
+gem 'rubocop-performance'
+gem 'rubocop-rspec'
+gem 'simplecov', '0.21.2'
+gem 'timecop'
+gem 'yard'

data/Gemfile.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: .
+  specs:
+    redis-objects-periodical (0.4.0)
+      redis-objects
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    redis (4.7.1)
+    redis-objects (1.7.0)
+      redis
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rspec_junit_formatter (0.5.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.10.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (1.44.1)
+      rubocop (~> 0.87)
+      rubocop-ast (>= 0.7.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    timecop (0.9.5)
+    unicode-display_width (1.8.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  aarch64-linux
+  x86_64-darwin-19
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (>= 2.0)
+  pry-byebug
+  rake (~> 13.0)
+  redis-objects-periodical!
+  rspec (~> 3.11)
+  rspec_junit_formatter
+  rubocop (~> 0.80)
+  rubocop-performance
+  rubocop-rspec
+  simplecov (= 0.21.2)
+  timecop
+  yard
+
+BUNDLED WITH
+   2.3.18

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Ryosuke Sato
+
+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.