supertag 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c795e9e93b046fe42eb0ab82c12e209619b7fde
+  data.tar.gz: f29d8f753739100fe8462806f69491b66c033931
+SHA512:
+  metadata.gz: dcc50fa0b6731aca9dc7cb0bdba8d9ba2e5103f7458c6e2e622a8ad0386b7aa16e2476f93b6ab264206b5bf0da0bfbcf9ca1af2154e8d88988f3b3a57205c1cf
+  data.tar.gz: 6f5fcc47d7c5f6c41720c8fe387f10d0249b09b15bafeb9fb6b7065e76e1b3418452973a0e9e53d11eb78b73c9eb318bed60245331d969c61fd54fdad5a9c820

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+**/*.log
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+_Notes.txt
+*.sqlite3

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_hashtag.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Taylor Mitchell
+
+MIT License
+
+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,191 @@
+# Supertag
+
+
+This gem is for tagging users using the "@", tagging things using the "#", tagging whatever else with "$" and in the future allowing extentions of the tags with "%". It will search your code and create a page with those attributes.
+
+Thank you Raphael Campardou for use of your gem(simple_hashtag)
+This is a work in progress, right now. It allows for the use of "$", "#", "@", and "%". The "%" is a future work in progress for allowing an attribute. For example: @somealias%private would create a private message. For now use it if you wish, but that one is not complete as of now. If you would like to contribute, by all means fork and let me know! Or collaborate with me as well so we can improve this. Any questions/comments/additions you would like to see/subtractions you think I should do/or just to tell me that you think this is awesome(or sucks) can be done through github/scy0846 or the email address in the gemfile.
+
+It's simple, and like all things simple, it can create a nice effect, quickly.
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'supertag'
+```
+
+And execute:
+```shell
+$ bundle
+```
+
+Then you have to generate the migration files:
+```shell
+$ rails g supertag:migration
+```
+
+This will create two migration files, one for the `tags` table and one for the `tagging` table.
+You will need to run `rake db:migrate` to actually create the tables.
+
+__Optionnally__, you can create views,
+if only to guide you through your own implementation:
+```shell
+$ rails g supertag:views
+```
+
+**you may need a partial file in your fiew of _posts(or whatever content your using)**
+
+This will create a __basic controller__, a __short index view__ and a __small helper__.
+It assume your views follow the convention of having a directory named after your model's plural, and a partial named after your model's name.
+```
+app
+|-- views
+|    |-- posts
+|    |    |-- _post.html.erb
+```
+
+
+## Usage
+
+Just add `include Supertag::Taggable` in your model.
+
+_Simple Hasthag_ will parse the `body` attribute by default:
+
+```ruby
+class Post < ActiveRecord::Base
+  include Supertag::Taggable
+end
+```
+
+
+If you need to parse another attribute instead,
+add `taggable_attribute` followed by the name of your attribute, i.e.:
+```ruby
+class Picture < ActiveRecord::Base
+  include Supertag::Taggable
+  taggable_attribute :caption
+end
+```
+
+From here on, if your text contains a tag, say _@RubyRocks_,
+_Supertag_ will find it, store it in a table and retreive it and its associated object if asked.
+---------------------------------------------------------------------------------------
+Helpers are also available to create a link when displaying the text.
+To use the helper, if you are new to rails you would place in your view page
+
+<%= linkify_tags(taggable_content) %>
+
+when you use this helper it will read the content find the hashtags and spew all of your content back on the page with links on the taggables. If you have your content tag above it and the helper tag below that realize you will repeat your content. Hopefully this will save you some time.
+----------------------------------------------------------------------------------------
+### Controller and Views
+If you don't want to bother looking at the generated controller and views, here is a quick peek.
+In a Controller, display all tags, or search for a Tag and its associated records:
+```ruby
+class TagsController < ApplicationController
+  def index
+    @tags = Supertag::Tag.all
+  end
+
+  def show
+    @tag = Supertag::Tag.find_by_name(params[:tag])
+    @tagged = @tag.taggables if @tag
+  end
+end
+```
+
+The views could resemble something like this:
+
+Index:
+```erb
+<h1>Tags</h1>
+<ul>
+<% @tags.each do |tag| %>
+  <li><%= link_to tag.name, tag_path(tag.name) %></li>
+<% end -%>
+</ul>
+```
+
+Show:
+```erb
+<h1><%= params[:tag] %></h1>
+<% if @tagged %>
+  <% @tagged.each do |tagged| %>
+    <% view    = tagged.class.to_s.underscore.pluralize %>
+    <% partial = tagged.class.to_s.underscore %>
+    <%= render "#{view}/#{partial}", {partial.to_sym => tagged} %>
+  <% end -%>
+<% else -%>
+  <p>There is no match for the <em><%= params[:tag] %></em> tag.</p>
+<% end -%>
+```
+In the gem it is actually extracted in a helper.
+
+
+### Routes
+
+If you use the provided controller and views, the generator will add two routes to your app:
+```ruby
+get 'tags/',         to: 'tags#index',     as: :tags
+get 'tags/:tag', to: 'tags#show',      as: :tag
+```
+
+The helper generating the link relies on it.
+
+
+
+### Spring Cleaning
+There is a class method `Supertag::Tag#clean_orphans` to remove unused tags from the DB.
+It is currently not hooked, for two reasons:
+- It is not optimised at all, DB-wise.
+- Destructive method should be called explicitly.
+
+Knowing all this, you can hook it after each change, or automate it with a Cron job, or even spring-clean manually once in a while.
+
+Improvements for this method are listed in the Todo section below.
+
+
+## Gotchas
+### Association Query
+The association between a Tag and your models is a polymorphic many-to-many.
+
+The object returned by the query is an array, not an Arel query, so you can't chain (i.e.: to specify the order), and should do it by hand:
+
+```ruby
+tag = Supertag.find_by_name("RubyRocks")
+posts_and_picts = tag.taggables
+posts_and_picts.sort_by! { |p| p.created_at }
+```
+
+### find_by
+
+To preserve coherence, Tags are stored downcased.
+To ensure coherence, they are also searched downcased.
+Internally, the model overrides `find_by_name` to perform the downcase query.
+Should you search Tags manually you should use the `Supertag::Tag#find_by_name` method, instead of `Supertag::Tag.find_by(name: 'RubyRocks')`
+
+
+## ToDo
+
+_Supertag_ is in its very early stage and would need a lot of love to reach 1.0.0.
+Among the many improvement areas:
+
+- Code for only allowing a user to be tagged and not create a completely new user.
+- Code for replying to a feed using @
+- Update clean orphans code to find rogue users
+- Code for attributes and only allowing certain attributes
+
+## Contributing
+
+All contributions are welcome.
+I might not develop new features (unless a project does require it),
+but I will definitely merge any interesting feature or bug fix quickly.
+
+You know the drill:
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add passing tests
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

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

data/lib/generators/supertag/migration_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators/active_record'
+
+module Supertag
+  module Generators
+    class MigrationGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def self.next_migration_number(path)
+        ActiveRecord::Generators::Base.next_migration_number(path)
+      end
+
+      def generate_migration
+          migration_template "migrations/create_hashtags_migration.rb", "db/migrate/create_supertag_hashtags.rb"
+          migration_template "migrations/create_hashtaggings_migration.rb", "db/migrate/create_supertag_hashtaggings.rb"
+          migration_template "migrations/create_usertags_migration.rb", "db/migrate/create_supertag_usertags.rb"
+          migration_template "migrations/create_usertaggings_migration.rb", "db/migrate/create_supertag_usertaggings.rb"
+          migration_template "migrations/create_moneytags_migration.rb", "db/migrate/create_supertag_moneytags.rb"
+          migration_template "migrations/create_moneytaggings_migration.rb", "db/migrate/create_supertag_moneytaggings.rb"
+      end
+    end
+  end
+end

data/lib/generators/supertag/templates/migrations/create_hashtaggings_migration.rb

@@ -0,0 +1,11 @@
+# This migration comes from supertag
+class CreateSupertagHashtaggings < ActiveRecord::Migration
+  def change
+    create_table :supertag_hashtaggings do |t|
+      t.references :hashtag,      :index => true
+      t.references :hashtaggable, :polymorphic => true
+    end
+    add_index :supertag_hashtaggings, ["hashtaggable_id", "hashtaggable_type"],
+              :name => 'index_hashtaggings_hashtaggable_id_hashtaggable_type'
+  end
+end

data/lib/generators/supertag/templates/migrations/create_hashtags_migration.rb

@@ -0,0 +1,10 @@
+# This migration comes from supertag
+class CreateSupertagHashtags < ActiveRecord::Migration
+  def change
+    create_table :supertag_hashtags do |t|
+      t.string :name,             :index => true
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/supertag/templates/migrations/create_moneytaggings_migration.rb

@@ -0,0 +1,11 @@
+# This migration comes from supertag
+class CreateSupertagMoneytaggings < ActiveRecord::Migration
+  def change
+    create_table :supertag_moneytaggings do |t|
+      t.references :moneytag,      :index => true
+      t.references :moneytaggable, :polymorphic => true
+    end
+    add_index :supertag_moneytaggings, ["moneytaggable_id", "moneytaggable_type"],
+              :name => 'index_moneytaggings_moneytaggable_id_moneytaggable_type'
+  end
+end

data/lib/generators/supertag/templates/migrations/create_moneytags_migration.rb

@@ -0,0 +1,10 @@
+# This migration comes from supertag
+class CreateSupertagMoneytags < ActiveRecord::Migration
+  def change
+    create_table :supertag_moneytags do |t|
+      t.string :name,             :index => true
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/supertag/templates/migrations/create_usertaggings_migration.rb

@@ -0,0 +1,11 @@
+# This migration comes from supertag
+class CreateSupertagUsertaggings < ActiveRecord::Migration
+  def change
+    create_table :supertag_usertaggings do |t|
+      t.references :usertag,      :index => true
+      t.references :usertaggable, :polymorphic => true
+    end
+    add_index :supertag_usertaggings, ["usertaggable_id", "usertaggable_type"],
+              :name => 'index_usertaggings_usertaggable_id_usertaggable_type'
+  end
+end

data/lib/generators/supertag/templates/migrations/create_usertags_migration.rb

@@ -0,0 +1,10 @@
+# This migration comes from supertag
+class CreateSupertagUsertags < ActiveRecord::Migration
+  def change
+    create_table :supertag_usertags do |t|
+      t.string :name,             :index => true
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/supertag/templates/views/hashtags_controller.rb

@@ -0,0 +1,10 @@
+class HashtagsController < ApplicationController
+  def index
+    @hashtags = Supertag::Hashtag.all
+  end
+
+  def show
+    @hashtag = Supertag::Hashtag.find_by_name(params[:hashtag])
+    @hashtagged = @hashtag.hashtaggables if @hashtag
+  end
+end

data/lib/generators/supertag/templates/views/hashtags_index.html.erb

@@ -0,0 +1,6 @@
+<h1>Hashtags</h1>
+<ul>
+<% @hashtags.each do |hashtag| %>
+  <li><%= link_to hashtag.name, hashtag_path(hashtag.name) %></li>
+<% end -%>
+</ul>

data/lib/generators/supertag/templates/views/hashtags_show.html.erb

@@ -0,0 +1,8 @@
+<h1><%= params[:hashtag] %></h1>
+<% if @hashtagged %>
+  <% @hashtagged.each do |hashtagged| %>
+    <%= render_hashtaggable hashtagged %>
+  <% end -%>
+<% else -%>
+  <p>There is no match for the <em><%= params[:hashtag] %></em> hashtag.</p>
+<% end -%>

data/lib/generators/supertag/templates/views/moneytags_controller.rb

@@ -0,0 +1,10 @@
+class MoneytagsController < ApplicationController
+  def index
+    @moneytags = Supertag::Moneytag.all
+  end
+
+  def show
+    @moneytag = Supertag::Moneytag.find_by_name(params[:moneytag])
+    @moneytagged = @moneytag.moneytaggables if @moneytag
+  end
+end

data/lib/generators/supertag/templates/views/moneytags_index.html.erb

@@ -0,0 +1,6 @@
+<h1>Moneytags</h1>
+<ul>
+<% @moneytags.each do |moneytag| %>
+  <li><%= link_to moneytag.name, moneytag_path(moneytag.name) %></li>
+<% end -%>
+</ul>

data/lib/generators/supertag/templates/views/moneytags_show.html.erb

@@ -0,0 +1,8 @@
+<h1><%= params[:moneytag] %></h1>
+<% if @moneytagged %>
+  <% @moneytagged.each do |moneytagged| %>
+    <%= render_moneytaggable moneytagged %>
+  <% end -%>
+<% else -%>
+  <p>There is no match for the <em><%= params[:moneytag] %></em> moneytag.</p>
+<% end -%>

data/lib/generators/supertag/templates/views/tags_helper.rb

@@ -0,0 +1,36 @@
+module TagsHelper
+  REGEXS = [[Supertag::Usertag::USERTAG_REGEX, :usertag_path], 
+            [Supertag::Hashtag::HASHTAG_REGEX, :hashtag_path], 
+            [Supertag::Moneytag::MONEYTAG_REGEX, :moneytag_path]]
+
+  def linkify_tags(taggable_content)
+    text = taggable_content.to_s
+
+    REGEXS.each do |regex, path|
+      text = text.gsub(regex) {link_to($&, send(path, $2), class: 'tag')}
+    end     
+
+    text.html_safe
+  end
+
+  def render_hashtaggable(hashtaggable)
+    klass        = hashtaggable.class.to_s.underscore
+    view_dirname = klass.pluralize
+    partial      = klass
+    render "#{view_dirname}/#{partial}", {klass.to_sym => hashtaggable}
+  end
+
+  def render_usertaggable(usertaggable)
+    klass        = usertaggable.class.to_s.underscore
+    view_dirname = klass.pluralize
+    partial      = klass
+    render "#{view_dirname}/#{partial}", {klass.to_sym => usertaggable}
+  end
+
+  def render_moneytaggable(moneytaggable)
+    klass        = moneytaggable.class.to_s.underscore
+    view_dirname = klass.pluralize
+    partial      = klass
+    render "#{view_dirname}/#{partial}", {klass.to_sym => moneytaggable}
+  end
+end