hashtags 0.1.0

data/lib/hashtags/resource.rb

@@ -0,0 +1,92 @@
+require 'active_support/core_ext/string/inflections'
+
+module Hashtags
+  class Resource < Base
+    # implement as resource class in your application
+    def self.resource_class
+      raise NotImplementedError
+    end
+
+    def self.find_by_resource_type(resource_type)
+      descendants.detect{ |cls| cls.resource_name.to_s == resource_type.to_s }
+    end
+
+    def self.resource_name
+      resource_class.to_s.demodulize.underscore
+    end
+
+    def self.cache_key
+      resource_class.cache_key
+    end
+
+    def self.trigger
+      '#'
+    end
+
+    # name of attribute to be used in the tag
+    # #resource_name:<tag_attribute>(id)
+    # (for example :to_s)
+    def self.tag_attribute
+      raise NotImplemented
+    end
+
+    # the tags will be replaced by this attribute
+    # (for example :link_to)
+    def self.result_attribute
+      raise NotImplemented
+    end
+
+    def self.regexp
+      /#{Regexp.escape(trigger)}#{resource_name}:(.+?)\((.+?)\b\)/i
+    end
+
+    def self.help_values
+      [resource_name]
+    end
+
+    # ---------------------------------------------------------------------
+    # JS
+
+    def self.match_regexp
+      /(#{Regexp.escape(trigger)}#{resource_name}\:)(\w{1,})\z/
+    end
+
+    def self.match_index
+      2
+    end
+
+    def self.match_template
+      "{{ #{tag_attribute} }}"
+    end
+
+    def self.replace
+      "#{trigger}#{resource_name}:{{ #{tag_attribute} }}({{ id }})"
+    end
+
+    def self.template
+      "{{ #{tag_attribute} }}"
+    end
+
+    private # =============================================================
+
+    def hashtag(match)
+      return unless id = match[self.class.match_index]
+      return unless res = resource(id)
+      Handlebars::Context.new
+                         .compile(self.class.replace)
+                         .call(id: res.id.to_s, self.class.tag_attribute => res.send(self.class.tag_attribute))
+    end
+
+    def markup(match)
+      return unless id = match[self.class.match_index]
+      return unless res = resource(id)
+      res.send(self.class.result_attribute)
+    end
+
+    # finds resource based on tag_attribute_value
+    # (for example resource_class.find(value))
+    def resource(value)
+      raise NotImplemented
+    end
+  end
+end

data/lib/hashtags/resource_type.rb

@@ -0,0 +1,56 @@
+require 'active_support/descendants_tracker'
+
+module Hashtags
+  class ResourceType < Base
+    def self.trigger
+      '#'
+    end
+
+    def self.regexp
+      /#{trigger}(.+?)\b/i
+    end
+
+    def self.resource_classes
+      Resource.descendants
+    end
+
+    # ---------------------------------------------------------------------
+    # JS
+
+    def self.match_regexp
+      /(\A#{trigger}|\s#{trigger})(\w*)\z/
+    end
+
+    def self.match_index
+      2
+    end
+
+    def self.replace
+      '$1{{ this }}:'
+    end
+
+    def self.template
+      '{{ this }}'
+    end
+
+    # ---------------------------------------------------------------------
+
+    def self.values(hashtag_classes = Resource.descendants)
+      (resource_classes & hashtag_classes).map(&:resource_name)
+    end
+
+    def self.cache_key
+      resource_classes.map(&:resource_name)
+    end
+
+    private # =============================================================
+
+    def hashtag(match)
+      # do nothing
+    end
+
+    def markup(match)
+      # do nothing
+    end
+  end
+end

data/lib/hashtags/user.rb

@@ -0,0 +1,92 @@
+require 'handlebars'
+
+module Hashtags
+  class User < Base
+    # implement as user class in your application
+    def self.resource_class
+      raise NotImplemented
+    end
+
+    def self.resource_name
+      resource_class.to_s.demodulize.underscore
+    end
+
+    # override for custom cache_key
+    def self.cache_key
+      resource_class.cache_key
+    end
+
+    def self.trigger
+      '@'
+    end
+
+    # name of attribute to be used in the tag
+    # @<tag_attribute> (for example :username)
+    def self.tag_attribute
+      raise NotImplemented
+    end
+
+    # the tags will be replaced by this attribute
+    # (for example :full_name)
+    def self.result_attribute
+      raise NotImplemented
+    end
+
+    def self.regexp
+      /#{Regexp.escape(trigger)}(\w+)/i
+    end
+
+    def self.help_values
+      [resource_name]
+    end
+
+    # ---------------------------------------------------------------------
+    # JS
+
+    def self.match_regexp
+      /(\A#{Regexp.escape(trigger)}|\s#{Regexp.escape(trigger)})(\w{1,})\z/
+    end
+
+    def self.match_index
+      2
+    end
+
+    def self.match_template
+      "{{ #{tag_attribute} }}"
+    end
+
+    def self.replace
+      "#{trigger}{{ #{tag_attribute} }}"
+    end
+
+    def self.template
+      "{{ #{tag_attribute} }}"
+    end
+
+    private # =============================================================
+
+    # updates found tags with tag value from resource
+    # @jtschichold => @JTschichold
+    def hashtag(match)
+      return unless id = match[self.class.match_index-1]
+      return unless user = resource(id)
+      Handlebars::Context.new
+                         .compile(self.class.replace)
+                         .call(self.class.tag_attribute => user.send(self.class.tag_attribute))
+    end
+
+    # replaces tags with result from resource
+    # @JTschichold => Jan Tschichold
+    def markup(match)
+      return unless id = match[self.class.match_index-1]
+      return unless user = resource(id)
+      user.send(self.class.result_attribute)
+    end
+
+    # finds resource based on tag_attribute_value
+    # for example: resource_class.where(username: tag_attribute_value).first
+    def resource(value)
+      raise NotImplemented
+    end
+  end
+end

data/lib/hashtags/variable.rb

@@ -0,0 +1,59 @@
+module Hashtags
+  class Variable < Base
+    def self.trigger
+      '$'
+    end
+
+    def self.regexp
+      /#{Regexp.escape(trigger)}(.+?)\b/i
+    end
+
+    def self.values(hashtag_classes = Variable.descendants)
+      raise NotImplemented
+    end
+
+    def self.help_values
+      values
+    end
+
+    # ---------------------------------------------------------------------
+    # JS
+
+    def self.match_regexp
+      /(\A#{Regexp.escape(trigger)}|\s#{Regexp.escape(trigger)})(\w{1,})\z/
+    end
+
+    def self.match_index
+      2
+    end
+
+    def self.replace
+      "#{trigger}{{ this }}"
+    end
+
+    def self.template
+      '{{ this }}'
+    end
+
+    def self.strategy(hashtag_classes)
+      super.tap { |obj| obj[:values] = compound_values(hashtag_classes) }
+    end
+
+    def self.compound_values(hashtag_classes)
+      cls = Builder.new.filter_classes(variable_classes & hashtag_classes)
+      cls.map { |i| i.values(hashtag_classes) }.flatten.compact
+    end
+
+    private # =============================================================
+
+    def hashtag(match)
+      return unless name(match)
+      [self.class.trigger, name(match)].join
+    end
+
+    def name(match)
+      return unless self.class.values.include?(match[1])
+      match[1]
+    end
+  end
+end

data/lib/hashtags/version.rb

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

metadata

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification
+name: hashtags
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomas Celizna
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: handlebars
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rails-assets-jquery-textcomplete
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails-assets-handlebars
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-minitest
+  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: 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: slim
+  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'
+description: 
+email:
+- tomas.celizna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/hashtags/resources_controller.rb
+- app/helpers/hashtags/view_helper.rb
+- app/views/hashtags/_help.slim
+- bin/console
+- bin/setup
+- config/locales/.gitkeep
+- config/locales/hashtags/builder.en.yml
+- config/routes.rb
+- hashtags.gemspec
+- lib/assets/javascripts/hashtags.js
+- lib/assets/javascripts/hashtags/hashtags.coffee
+- lib/assets/stylesheets/hashtags.css
+- lib/assets/stylesheets/hashtags/help.scss
+- lib/assets/stylesheets/hashtags/textcomplete.scss
+- lib/hashtags.rb
+- lib/hashtags/base.rb
+- lib/hashtags/builder.rb
+- lib/hashtags/engine.rb
+- lib/hashtags/mongoid_extension.rb
+- lib/hashtags/resource.rb
+- lib/hashtags/resource_type.rb
+- lib/hashtags/user.rb
+- lib/hashtags/variable.rb
+- lib/hashtags/version.rb
+homepage: https://github.com/tomasc/hashtags
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Rails engine to facilitate inline text hashtags.
+test_files: []