activityko 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85650ce75cf3c80e8b9d16899a8af0b6840d75c6
+  data.tar.gz: a8620a8c25b0bd40aaf1c2b3d2b9657a3258f425
+SHA512:
+  metadata.gz: eeac9e0f7a31f243cda1cfab9aae99fa9618af8a3b3a113bd734d065896b50b58ecbc82493673227a953d368fa38b714b3d17c4986f83c84f9b608555d594455
+  data.tar.gz: 263f40f1fc552f3455f1a68311d4789a71d5280c0e84abad2a3655dd62d88bbbe80092c37758e0759f5664f708c1c135388601a1beddc94961629884c27dd8da

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.1
+before_install: gem install bundler -v 1.14.2

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 valerosjoseph@gmail.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,18 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activityko.gemspec
+
+gemspec
+
+gem 'actionpack', '~> 5.1'
+gem 'railties', '~> 5.1'
+# 
+# group :development, :test do
+#   gem 'sqlite3', '~> 1.3.7'
+#   gem 'mocha', '~> 0.13.0', require: false
+#   gem 'simplecov', '~> 0.7.0'
+#   gem 'minitest', '~> 4.7.5'
+#   gem 'redcarpet'
+#   gem 'yard', '~> 0.8'
+#   gem 'activerecord', '~> 4.0.0'
+# end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 linkin
+
+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,90 @@
+# Activityko
+An activity logger for rails 5. It provides view helpers to render basic format of activity.
+
+## Installation
+
+```ruby
+gem 'activityko'
+```
+
+And then execute:
+
+    $ bundle
+Then generate model and migration files
+
+    $ rails g activityko:install
+    $ rake db:migrate
+
+## Usage
+### Owner of the Activity
+Add this to your ```User``` model
+```ruby
+class User < ApplicationRecord
+  act_as_loggable
+end
+```
+This will add ```create_activity(action, options={})``` method to your model
+### Object of the Activity
+Then, make all possible objects of ```Activity``` an activty object.
+
+```ruby
+class Group < ApplicationRecord
+  act_as_activity_object
+end
+class Location <ApplicationRecord
+  act_as_activity_object
+end
+```
+or
+``` ruby
+class ApplicationRecord < ActiveRecord::Base
+  act_as_activity_object
+end
+```
+
+An ```activity_name``` method is added to all activity objects.
+
+The ```User``` model is also an activity object.
+
+### View Helpers
+User ``` basic_activity ``` method to display an activity
+
+```ruby
+<% @activities.each do |a| %>
+  <%= basic_activity %>
+<% end %>
+```
+or
+basic_activity also accepts ```block```
+```ruby
+<% basic_activity @activity do%>
+  <%= activity_subj %>
+	<%= activity_action %>
+	<%= activity_dir_obj %>
+	<%= activity_prep %>
+	<%= activity_prep_obj %>
+	<%= activity_time %>
+<% end %>
+```
+
+You can customize each activity output by using ```render_activity```. Inspired by [Public Activity](https://github.com/chaps-io/public_activity)  gem. Check it out.
+
+```ruby
+  <%= render_activity @activity%>
+```
+File structure
+```
+app:
+  views:
+    activities:
+      <activity_obj_model>:
+        _<activity_action>.html.erb
+```
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/neume/activityko. 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).

data/Rakefile

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

data/activityko.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activityko/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activityko"
+  spec.version       = Activityko::VERSION
+  spec.authors       = ["Joseph Nelson Valeros"]
+  spec.email         = ["valerosjoseph@gmail.com"]
+
+  spec.summary       = %q{An activity logger for Rails 5}
+  spec.description   = %q{An activity logger for rails 5 that provides view helpers to render basic format of activity.}
+  spec.homepage      = "https://github.com/neume/activityko"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  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 'activerecord', '>= 5.1'
+	spec.add_dependency 'actionview', '>= 5.1'
+	spec.add_dependency 'actionpack', '>= 5.1'
+	spec.add_dependency 'railties', '>= 5.1'
+	spec.add_dependency 'activesupport', '>= 5.1'
+	spec.add_development_dependency 'sqlite3'
+	spec.add_development_dependency "generator_spec"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activityko"
+
+# 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/activityko.rb

@@ -0,0 +1,7 @@
+require "activityko/version"
+require "activityko/loggable"
+require "activityko/view_helpers"
+require 'active_record'
+module Activityko
+end
+ActiveRecord::Base.send :extend, Activityko::Loggable

data/lib/activityko/activity_object.rb

@@ -0,0 +1,7 @@
+module Activityko
+	module ActivityObject
+		def activity_name
+			try(:name) || self.class.to_s
+		end
+	end
+end

data/lib/activityko/activity_subject.rb

@@ -0,0 +1,13 @@
+require 'active_support/concern'
+module Activityko
+	module ActivitySubject
+		extend ActiveSupport::Concern
+		included do
+			has_many :activities, as: :subj
+		end
+	  def create_activity action, options={}
+			options.merge!({action: action})
+			activities.create(options)
+		end
+	end
+end

data/lib/activityko/loggable.rb

@@ -0,0 +1,13 @@
+require "activityko/activity_subject"
+require "activityko/activity_object"
+module Activityko
+	module Loggable
+		def act_as_loggable
+			include Activityko::ActivitySubject
+			include Activityko::ActivityObject
+		end
+		def act_as_activity_object
+			include Activityko::ActivityObject
+		end
+	end
+end

data/lib/activityko/version.rb

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

data/lib/activityko/view_helpers.rb

@@ -0,0 +1,45 @@
+require "action_view"
+module Activityko
+	module ViewHelpers
+		def render_activity activity
+	    render partial: "activities/#{activity.dir_obj_type.downcase}/#{activity.action}",
+	      locals: { activity: activity } rescue basic_activity(activity)
+	  end
+	  def basic_activity activity
+			@activityko_instance = activity
+			if block_given?
+				yield
+			else
+		    sentence = []
+		    sentence << activity_subj if activity.subj
+		    sentence << activity_action
+		    sentence << activity_dir_obj if activity.dir_obj
+		    sentence << activity_prep if activity.prep
+		    sentence << activity_prep_obj if activity.prep_obj
+		    return sentence.join(" ").html_safe
+			end
+	  end
+		def activity_dir_obj
+			dir_obj = @activityko_instance.dir_obj
+			link_to dir_obj.activity_name, dir_obj
+		end
+	  def activity_subj
+			subj = @activityko_instance.subj
+	    link_to(subj.activity_name, subj)
+	  end
+		def activity_action
+			@activityko_instance.action.humanize.downcase
+		end
+		def activity_prep
+			@activityko_instance.prep.humanize.downcase
+		end
+		def activity_prep_obj
+			prep_obj = @activityko_instance.prep_obj
+			link_to prep_obj.activity_name, prep_obj
+		end
+	  def activity_time
+	    time_ago_in_words @activityko_instance.created_at
+	  end
+	end
+	ActionView::Base.send :include, ViewHelpers
+end

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

@@ -0,0 +1,20 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+require 'generators/activityko/model/model_generator'
+require 'generators/activityko/migration/migration_generator'
+module Activityko
+	module Generators
+		class InstallGenerator < Rails::Generators::Base
+			include Rails::Generators::Migration
+			def self.next_migration_number(dirname)
+				ActiveRecord::Generators::Base.next_migration_number(dirname)
+			end
+			source_root File.expand_path("../..", __FILE__)
+			desc "generates migration file"
+			def generate_migration
+				migration_template 'migration/templates/migration.rb', 'db/migrate/create_activities.rb'
+				copy_file 'model/templates/activity.rb', 'app/models/activity.rb'
+			end
+		end
+	end
+end

data/lib/generators/activityko/migration/migration_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+module Activityko
+	module Generators
+		class MigrationGenerator < Rails::Generators::Base
+			include Rails::Generators::Migration
+		  def self.next_migration_number(dirname)
+		    ActiveRecord::Generators::Base.next_migration_number(dirname)
+		  end
+			source_root File.expand_path("../templates", __FILE__)
+			desc "generates migration file"
+			def generate_migration
+				migration_template 'migration.rb', 'db/migrate/create_activities.rb'
+			end
+		end
+	end
+end

data/lib/generators/activityko/migration/templates/migration.rb

@@ -0,0 +1,24 @@
+class CreateActivities < ActiveRecord::Migration
+  def change
+    create_table :activities do |t|
+    	t.belongs_to :subj, polymorphic: true
+    	t.string		 :action
+    	t.belongs_to :dir_obj, polymorphic: true
+    	t.string		 :prep
+    	t.belongs_to :prep_obj, polymorphic: true
+			t.integer		 :level, default: 0
+
+    	t.json			 :params
+
+    	t.integer 	 :status, default: 0
+    	t.integer		 :activity_status, default: 0
+      t.integer    :activity_type, default: 0
+
+    	t.datetime	 :deleted_at
+      t.timestamps
+    end
+		add_index :activities, [:subj_id, :subj_type]
+		add_index :activities, [:dir_obj_id, :dir_obj_type]
+		add_index :activities, [:prep_obj_id, :prep_obj_type]
+  end
+end

data/lib/generators/activityko/model/model_generator.rb

@@ -0,0 +1,11 @@
+module Activityko
+	module Generators
+		class ModelGenerator < Rails::Generators::Base
+			source_root File.expand_path("../templates", __FILE__)
+			desc "generates models/activity.rb"
+			def generate_model
+				copy_file 'activity.rb', 'app/models/activity.rb'
+			end
+		end
+	end
+end

data/lib/generators/activityko/model/templates/activity.rb

@@ -0,0 +1,5 @@
+class Activity <ActiveRecord::Base
+	belongs_to :subj, polymorphic: true
+	belongs_to :dir_obj, polymorphic: true, optional: true
+	belongs_to :prep_obj, polymorphic: true, optional: true
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: activityko
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph Nelson Valeros
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: generator_spec
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: An activity logger for rails 5 that provides view helpers to render basic
+  format of activity.
+email:
+- valerosjoseph@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activityko.gemspec
+- bin/console
+- bin/setup
+- lib/activityko.rb
+- lib/activityko/activity_object.rb
+- lib/activityko/activity_subject.rb
+- lib/activityko/loggable.rb
+- lib/activityko/version.rb
+- lib/activityko/view_helpers.rb
+- lib/generators/activityko/install/install_generator.rb
+- lib/generators/activityko/migration/migration_generator.rb
+- lib/generators/activityko/migration/templates/migration.rb
+- lib/generators/activityko/model/model_generator.rb
+- lib/generators/activityko/model/templates/activity.rb
+homepage: https://github.com/neume/activityko
+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.5.1
+signing_key: 
+specification_version: 4
+summary: An activity logger for Rails 5
+test_files: []