fancy_count 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5c280fb7de6316b3e72e4d328410d5c8905566e6f873827db0a5c376dc6a79e
-  data.tar.gz: 5ef9e946335db750937261deb4d2b6212dec712217301f46ec3e737999f78281
+  metadata.gz: f7eba097d00915da56ebfc8ce112f599c5401884ca422b582e7f7e35ba76d1b0
+  data.tar.gz: 381241c01bef7612772526f7408692133921acd336b38275a8e3f987f17ba6f0
 SHA512:
-  metadata.gz: dba3cd5bcc069fb1b13a852c3e3752d8bda941bf09d1a3e3883243169748e17b39b0f831779930193f77655c891b9026c8dc9afffd7ee1e2cabac2fcbc5119b6
-  data.tar.gz: b56aabb34bfdf71402e4425e6047aeb9af2ca4e329a43e5667fbef7b264a4fda912397806e641212565a4e161690e7c807a9b154c943c9121d2d84fd82b3ca21
+  metadata.gz: 6ce492065add358e229bcfb5488edf043e8c406a4f073b6d744509b20a98a7c6a853770c1d7019ca2a536e67de6a6c5348ff22cc39c1f9b9f90db6ed0a6cc967
+  data.tar.gz: 94db83e7d5899d2951a915c267b595b55f9fdb4a91bed796262cc8c4b89fe9f93c86d52f93cadfc18dd97a15c1f0883363954a5cf1613c5f54b7511c3129d94d

data/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - main
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.7', '3.0']
+    env:
+      BUNDLE_PATH_RELATIVE_TO_CWD: true
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler: default
+          bundler-cache: true
+
+      - name: StandardRb check
+        run: bundle exec standardrb
+
+      - name: Run tests
+        run: bundle exec rspec spec

data/.overcommit.yml

@@ -0,0 +1,32 @@
+# Overcommit hooks run automatically on certain git operations, like "git commit".
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/sds/overcommit
+
+gemfile: false
+verify_signatures: false
+
+PreCommit:
+  BundleCheck:
+    enabled: true
+
+  FixMe:
+    enabled: true
+    keywords: ["FIXME"]
+    exclude:
+      - .overcommit.yml
+
+  LocalPathsInGemfile:
+    enabled: true
+
+  RuboCop:
+    enabled: true
+    required_executable: bundle
+    command: ["bundle", "exec", "standardrb"]
+    on_warn: fail
+
+  YamlSyntax:
+    enabled: true
+
+PostCheckout:
+  ALL:
+    quiet: true

data/CODE_OF_CONDUCT.md

@@ -39,7 +39,7 @@ This Code of Conduct applies within all community spaces, and also applies when
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at developer@companycam.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.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fancy_count (1.0.2)
+    fancy_count (1.0.4)
       activerecord (>= 4.2, < 7)
       activesupport (>= 4.2, < 7)
 

data/README.md

@@ -1,8 +1,10 @@
 # FancyCount
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fancy_count`. To experiment with that code, run `bin/console` for an interactive prompt.
+🎉 Enhanced counter management for your Ruby on Rails app.
+
+[![Build Status](https://github.com/CompanyCam/fancy-count/workflows/Tests/badge.svg)](https://github.com/CompanyCam/fancy-count/actions) [![Gem Version](https://badge.fury.io/rb/fancy_count.svg)](https://badge.fury.io/rb/fancy_count)
+
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -20,15 +22,87 @@ Or install it yourself as:
 
     $ gem install fancy_count
 
+## Configuration
+
+Make sure to define which adapter you want to use to persist the counters.
+
+```ruby
+# config/initializers/fancy_count.rb
+
+require 'fancy_count'
+
+FancyCount.configure do |config|
+  config.adapter = :redis
+end
+```
+
+
 ## Usage
 
-TODO: Write usage instructions here
+Fancy count is dead simple to drop in and get going.
+
+Example usage in IRB
+
+```ruby
+counter = FancyCount::Counter.new('my-counter')
+counter.increment
+counter.value # => 1
+counter.decrement # => 0
+```
+
+Example usage in an ActiveRecord Model
+
+```ruby
+class Company < ApplicationRecord
+  include FancyCount::HasCountable
+
+  fancy_counter :employees
+end
+
+company = Company.new
+company.fancy_employee_count # => 0
+company.fancy_employee_counter.increment
+company.fancy_employee_count # => 1
+```
+
+Example Counter Cache
+
+```ruby
+class Company < ApplicationRecord
+  include FancyCount::HasCountable
+
+  fancy_counter :employees
+end
+
+class Employee < ApplicationRecord
+  include FancyCount::CounterCacheable
+
+  belongs_to :company
+
+  fancy_counter_cache :employees, on: :company
+end
+
+company = Company.first
+company.fancy_employee_count # => 0
+company.employees.create(name: "bob marley")
+company.fancy_employee_count # => 1
+company.employees.destroy_all
+company.fancy_employee_count # => 0
+```
 
 ## 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Releasing a new version
+
+* install gem-release https://github.com/svenfuchs/gem-release
+* run `gem bump --version patch` if patching (otherwise switch "patch" out for "minor" or "major")
+* run `gem tag 1.x.x` replacing the "x" characters with appropriate values
+* run `git push --tags origin` to push the tags up to Github
+* Finally, run `gem release` which pushes the gem up to whatever repository (ex: Rubygems)
 
 ## Contributing
 

data/lib/fancy_count/adapter.rb

@@ -2,8 +2,9 @@
 
 module FancyCount
   class Adapter
-    def initialize(name)
+    def initialize(name, config)
       @name = name
+      @config = config
     end
 
     def increment

data/lib/fancy_count/configuration.rb

@@ -7,6 +7,7 @@ module FancyCount
     include ActiveSupport::Configurable
 
     config_accessor :adapter
+    config_accessor :expireat
 
     ADAPTER_CLASSES = {
       redis: FancyCount::RedisAdapter,
@@ -28,7 +29,7 @@ module FancyCount
     private
 
     def raise_missing_adapter_error(adapter_name)
-      message = %W{Missing adapter for #{adapter_name}, valid adapters are #{ADAPTER_CLASSES.keys.join(", ")}}
+      message = %W[Missing adapter for #{adapter_name}, valid adapters are #{ADAPTER_CLASSES.keys.join(", ")}]
       raise FancyCount::MissingAdapterError.new(message)
     end
   end

data/lib/fancy_count/counter.rb

@@ -34,7 +34,7 @@ module FancyCount
     private
 
     def adapter
-      @adapter ||= @config.adapter_class.new(@name)
+      @adapter ||= @config.adapter_class.new(@name, @config)
     end
   end
 end

data/lib/fancy_count/redis_adapter.rb

@@ -3,7 +3,11 @@
 module FancyCount
   class RedisAdapter < Adapter
     def counter
-      @counter ||= Redis::Counter.new(@name)
+      options = {}
+      if @config.expireat
+        options[:expireat] = @config.expireat
+      end
+      @counter ||= Redis::Counter.new(@name, options)
     end
   end
 end

data/lib/fancy_count/test_adapter.rb

@@ -16,8 +16,8 @@ module FancyCount
       @@counts = value
     end
 
-    def initialize(name)
-      super(name)
+    def initialize(name, config)
+      super(name, config)
       self.class.counts ||= {}
       self.class.counts[name] ||= 0
     end

data/lib/fancy_count/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FancyCount
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fancy_count
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - CompanyCam Engineering
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-09 00:00:00.000000000 Z
+date: 2021-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -170,7 +170,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".overcommit.yml"
 - ".rspec"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -214,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Yet Another Counter Library