lokap-trackable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0ae4c29d7774d20738d773bd45c5ac79a053f4798fcf4fee49e0bbe055a53d86
+  data.tar.gz: 1e5ffc08cc34aa5ff43ec491c729a72d3aec136f858c5b0777667295ca0351ff
+SHA512:
+  metadata.gz: a69c83051af26b3b2ccf031c968bc0fff4c31646b820a14f6e6ec30d9842a8287337051de3bc25100a0f00880e64748373c5161827a7f5d782c1033aaba43728
+  data.tar.gz: 73c5c84fd0a887175e1e07f061380bba50b10fae039a4170a7911d4cf17544e5352fcd0e3c807d2c4ac03f7f4f30a4bbe57b53d581e65abaef6ba0333c15e9ce

data/.yardopts

@@ -0,0 +1,5 @@
+--private
+--markup-provider=redcarpet
+--markup=markdown
+-
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-08-02
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+
+gem "yard"
+gem "redcarpet"
+gem "github-markup"
+
+gem 'lokap-verbs'
+

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    lokap-trackable (0.0.1)
+      lokap-verbs
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    concurrent-ruby (1.1.10)
+    github-markup (4.0.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    lokap-verbs (3.1.1)
+      activesupport (>= 2.3.4)
+      i18n
+    minitest (5.16.2)
+    rake (13.0.6)
+    redcarpet (3.5.1)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  github-markup
+  lokap-trackable!
+  lokap-verbs
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  redcarpet
+  yard
+
+BUNDLED WITH
+   2.3.18

data/README.md

@@ -0,0 +1,29 @@
+# Lokap::Trackable
+
+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/lokap/trackable`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add lokap-trackable
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install lokap-trackable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lokap-trackable.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/lib/lokap/trackable/activity.rb

@@ -0,0 +1,19 @@
+module Lokap
+  module Trackable
+    module Activity
+      def actor_name
+        actor ? actor.name : 'n/a'
+      end
+
+      def to_s
+        "#{created_at.strftime('%m/%d/%Y %l:%M%P')} - #{event_to_s} by #{actor_name}"
+      end
+
+      def event_to_s
+        event.split('.').last.titleize
+      end
+      alias :event_name :event_to_s
+    end
+  end
+end
+

data/lib/lokap/trackable/base.rb

@@ -0,0 +1,80 @@
+require 'verbs'
+require_relative 'table_utilities'
+require_relative 'refinements/verb_string'
+
+using Lokap::VerbString
+
+module Lokap
+  module Trackable
+    module Base
+      include TableUtilities
+
+      def trackable(subject, options={})
+        build_trackable(subject, options)
+      end
+
+      def build_trackable(name, options={})
+        repeatable = options.fetch(:repeatable, false)
+        class_name = trackable_class_name(options[:class_name])
+        event      = options[:event] || name
+        table_name = trackable_table_name(options[:class_name])
+
+        instance_eval do
+          has_many :activities, class_name: class_name, as: :reference
+
+          define_method(:activity?) do |event|
+            activities.where(event: event).first
+          end
+
+          define_method(:activity_by?) do |event, actor=Thread.current[:current_user] |
+            activities.where(actor: actor, event: event).first
+          end
+        end
+
+        verb = name.to_s.split('_').first
+        past_tense_verb = verb.to_s.verb.conjugate(tense: :past, aspect: :perfective)
+        past_tense = [past_tense_verb, name.to_s.split('_')[1..-1]].flatten.join('_')
+
+        scope past_tense, -> { joins(:activities).where(["event = ?", event]) }
+
+        # Clean up this mess.
+        scope "un#{past_tense}", -> {
+          joins("LEFT OUTER JOIN #{table_name} " <<
+            "ON #{table_name}.reference_id = #{arel_table.name}.id " <<
+            "AND #{table_name}.event = '#{event}'")
+            .where("#{table_name}.event" => nil) }
+
+        define_method("#{past_tense}?") do
+          !!activity?(event)
+        end
+
+        define_method("un#{past_tense}?") do
+          !activity?(event)
+        end
+
+        define_method("#{name}!") do |actor=Thread.current[:current_user], data=nil|
+          activity = activities.find_or_create_by(actor: actor, event: event, data: data)
+          activity.touch and return activity
+        end
+
+        define_method("un#{name}!") do |data=nil|
+          activities.where(event: event)&.destroy_all
+        end
+
+        # Not necessary at the moment
+        #
+        # define_method("#{name.to_s}!") do |actor, data={}|
+        #   return if repeatable && activity_by?(actor, name, event, table_name)
+        #   send(table_name.to_sym).create(
+        #     actor_id: actor.id, actor_type: actor.class.to_s, event: event, data: data)
+        # end
+        #
+        # define_method("un#{name.to_s}!") do |actor|
+        #   return unless activity_by?(actor, name, event, table_name)
+        #   send(table_name.to_sym).where(
+        #     actor_id: actor.id, actor_type: actor.class, event: event).first.destroy
+        # end
+      end
+    end
+  end
+end

data/lib/lokap/trackable/refinements/verb_string.rb

@@ -0,0 +1,7 @@
+module Lokap
+  module VerbString
+    refine String do
+      include ::Verbs::Verblike::Access
+    end
+  end
+end

data/lib/lokap/trackable/table_utilities.rb

@@ -0,0 +1,20 @@
+module Lokap
+  module Trackable
+    module TableUtilities
+      def trackable_method?(method)
+        method.to_s.split('_').first == 'trackable'
+      end
+
+      def trackable_table_name(class_name=nil)
+        return class_name.tableize unless class_name.nil?
+        [arel_table.name.singularize, "activities"].join('_')
+      end
+
+      def trackable_class_name(class_name=nil)
+        return class_name.classify unless class_name.nil?
+        "Activity".classify
+      end
+    end
+  end
+end
+

data/lib/lokap/trackable/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Lokap
+  module Trackable
+    VERSION = "0.0.1"
+  end
+end

data/lib/lokap/trackable.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+paths = File.expand_path("trackable/*.rb", __dir__)
+Dir.glob(paths).sort.each { |path| require path }
+
+module Lokap
+  module Trackable
+    def self.included(base)
+      base.extend(Base)
+    end
+  end
+end

data/sig/lokap/trackable.rbs

@@ -0,0 +1,6 @@
+module Lokap
+  module Trackable
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: lokap-trackable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Bair
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lokap-verbs
+  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'
+description:
+email:
+- adambair@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/lokap/trackable.rb
+- lib/lokap/trackable/activity.rb
+- lib/lokap/trackable/base.rb
+- lib/lokap/trackable/refinements/verb_string.rb
+- lib/lokap/trackable/table_utilities.rb
+- lib/lokap/trackable/version.rb
+- sig/lokap/trackable.rbs
+homepage: https://github.com/adambair/lokap-trackable
+licenses:
+- Nonstandard
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/adambair/lokap-trackable
+  source_code_uri: https://github.com/adambair/lokap-trackable
+  changelog_uri: https://github.com/adambair/lokap-trackable/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/adambair/lokap-trackable/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.14
+signing_key:
+specification_version: 4
+summary: Tracks activities/events on ActiveRecord models
+test_files: []