initial commit

Author: tomasc

.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+script: 'bundle exec rake'
+rvm:
+  - 2.2.5
+before_install:
+  - gem install bundler -v 1.12.5
+notifications:
+  email:
+    recipients:
+      - [email protected]
+    on_failure: change
+    on_success: never

Gemfile

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

Guardfile

@@ -0,0 +1,5 @@
+guard :minitest do
+  watch(%r{^lib/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch(%r{^test/test_helper\.rb$})                       { 'test' }
+end

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tomas Celizna
+
+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.

README.md

@@ -0,0 +1,150 @@
+# Hashtags
+
+[![Build Status](https://travis-ci.org/tomasc/hashtags.svg)](https://travis-ci.org/tomasc/hashtags) [![Gem Version](https://badge.fury.io/rb/hashtags.svg)](http://badge.fury.io/rb/hashtags) [![Coverage Status](https://img.shields.io/coveralls/tomasc/hashtags.svg)](https://coveralls.io/r/tomasc/hashtags)
+
+Set of models and JS plugins to facilitate inline text hashtags.
+
+* hashtags are entered inline in text, for example as `@tomasc`, `#location:Home(12345)` or `$my_variable`
+* when rendered, they are replaced by actual values, for example HTML tags, images, links etc.
+
+Additionally:
+
+* the user can be assisted with a dropdown triggered by a special character (`#`, `@`, `$`, …)
+* `has_hash_tag_field` method is available to assist when rendering HTML input fields incl. data attributes, help, and supporting only specified hashtag classes
+* hashtags typically have `cache_key` defined on class so corresponding fragment cache can be easily expired
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hashtags'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hashtags
+
+## Usage
+
+The hashtags have the following structure:
+
+```
+<trigger>(type)(human_id)<value>
+```
+
+The three following types are included in this gem, however the gem's design allows for definition of new types and their subclassing.
+
+### Hash tag types
+
+#### User hash tag
+
+```
+@tomasc
+```
+
+#### Resource hash tag
+
+```
+#location:Home(12345)
+```
+
+#### Variable hash tag
+
+```
+$number_of_users
+```
+
+### Adding new hash tags in your application
+
+The following are quick examples. It is advised to read the source code of `Hashtags::User`, `Hashtags::Resource` and `Hashtags::Variable` and their superclass `Hashtags::Builder` in order to fully understand the possibilities and flexibility of this gem.
+
+#### User
+
+See `Hashtags::User` and override its methods on your subclass as necessary. Typically it would be at least the following:
+
+```ruby
+class UserTag < Hashtags::User
+  def self.resource_class
+    # User
+  end
+
+  def self.resources_for_query(query)
+    # User.where(full_name: /#{query}/i)
+  end
+
+  def resource_as_json(resource)
+    # {
+    #   _id: resource.id.to_s,
+    #   to_s: resource.full_name,
+    #   human_id: resource.full_name
+    # }
+  end
+end
+```
+
+#### Resource
+
+See `Hashtags::Resource` and override its methods on your subclass as necessary. Typically it would be at least the following:
+
+```ruby
+class LocationTag < Hashtags::Resource
+  def self.resource_class
+    # Location
+  end
+
+  def self.resources_for_query(query)
+    # Location.where(name: /#{query}/i)
+  end
+
+  def resource_as_json(resource)
+    # {
+    #   _id: resource.id.to_s,
+    #   to_s: resource.name,
+    #   human_id: resource.name
+    # }
+  end
+end
+```
+
+#### Variable
+
+See `Hashtags::Variable` and override its methods on your subclass as necessary. Typically it would be at least the following:
+
+```ruby
+class LocationTag < Hashtags::Resource
+  def self.values(_hash_tag_classes)
+    # %w(
+    #   variable_1
+    #   variable_2
+    # )
+  end
+
+  def markup(match)
+    # case name(match)
+    # when 'variable_1' then get_value_of_variable_1(match)
+    # when 'variable_2' then get_value_of_variable_2(match)
+    # end
+  end
+end
+```
+
+
+## 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 tags, 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/tomasc/hashtags.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

Rakefile

@@ -0,0 +1,10 @@
+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

bin/console

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

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

hashtags.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hashtags/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hashtags'
+  spec.version       = Hashtags::VERSION
+  spec.authors       = ['Tomas Celizna']
+  spec.email         = ['[email protected]']
+
+  spec.summary       = 'Set of models and JS plugins to facilitate inline text hashtags.'
+  spec.homepage      = 'https://github.com/tomasc/hashtags'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-minitest'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

lib/hashtags.rb

@@ -0,0 +1,5 @@
+require "hashtags/version"
+
+module Hashtags
+  # Your code goes here...
+end

lib/hashtags/version.rb

@@ -0,0 +1,3 @@
+module Hashtags
+  VERSION = '0.1.0'.freeze
+end

test/support/.gitkeep

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+
+require 'minitest'
+require 'minitest/autorun'
+require 'minitest/spec'
+
+require 'hashtags'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }