sharing_tags 0.0.2

data/app/views/sharing_tags/meta_tags.html.slim

@@ -0,0 +1,16 @@
+/ Open graph markup for Facebook
+= render "sharing_tags/open_graphs", meta: sharing_tags.facebook if sharing_tags.facebook.present?
+
+/ Twitter Card data
+= render "sharing_tags/twitter_card", meta: sharing_tags.twitter if sharing_tags.twitter.present?
+
+/ Schema.org markup for Google+
+= render "sharing_tags/schema_tags", meta: sharing_tags.google if sharing_tags.google.present?
+
+/ Vkontakte https://vk.com/dev/share_details
+/ TODO:
+/link rel="image_src" href="/site-preview.jpg"
+
+
+/meta name=”description” content=”155 characters of message matching text with a call to action goes here”
+/<title>Up to 70 Characters of Keyword-relevant text here</title>

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

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

@@ -0,0 +1,18 @@
+require 'rails/generators'
+
+module SharingTags
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_initializer_file
+        template 'initializer.rb', 'config/initializers/sharing_tags.rb'
+      end
+
+      # todo: add javascript files to applications.js
+      # todo add styles application.css
+
+    end
+  end
+end

data/lib/generators/sharing_tags/install/templates/initializer.rb

@@ -0,0 +1,18 @@
+# This file was generated by the `rails generate sharing_tags:install` command.
+
+SharingTags.configure do
+
+  # global configuration
+  title         "Global site title"
+  description   "Global site description"
+  page_url      { root_url }
+  image         { image_url('img.jpg') }
+
+  # # for switch context call `sharing_tags.switch_context_to(:user)` in controller action
+  # context :user do
+  #   title         "User site title"
+  #   description  "User site description"
+  #   page_url     { profile_url }
+  # end
+
+end

data/lib/generators/sharing_tags.rb

@@ -0,0 +1,18 @@
+# Weirdly named generators namespace (should be `RSpec`) for compatability with
+# rails loading.
+module SharingTags
+  # @private
+  module Generators
+    # @private
+    class Base < ::Rails::Generators::NamedBase
+
+      # def self.source_root(path = nil)
+      #   if path
+      #     @_rspec_source_root = path
+      #   else
+      #     @_rspec_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'rspec', generator_name, 'templates'))
+      #   end
+      # end
+    end
+  end
+end

data/lib/sharing_tags/action_controller/filters.rb

@@ -0,0 +1,13 @@
+module SharingTags::ActionController::Filters
+  extend ActiveSupport::Concern
+
+  included do
+    append_before_filter :sharing_tags_clear_context
+  end
+
+  def sharing_tags_clear_context
+    logger.debug "SharingTags: clear context #{SharingTags.config.current_context.name}!" if logger.debug?
+    SharingTags.config.clear_context!
+  end
+
+end

data/lib/sharing_tags/action_controller/helpers.rb

@@ -0,0 +1,7 @@
+module SharingTags::ActionController::Helpers
+
+  def sharing_tags
+    SharingTags.config.within_context_params(view_context)
+  end
+
+end

data/lib/sharing_tags/action_view/helpers.rb

@@ -0,0 +1,57 @@
+module SharingTags::ActionView::Helpers
+
+  def sharing_tags
+    SharingTags.config.within_context_params(self)
+  end
+
+  def render_sharing_tags
+    logger.debug "SharingTags: Render meta tags context=#{SharingTags.config.current_context.name}, params=#{sharing_tags.to_hash.inspect}"
+    render template: "sharing_tags/meta_tags"
+  end
+
+  def link_to_facebook_share(name = "Facebook", &block)
+    share_link_to name, :facebook, [], &block
+  end
+
+  def link_to_vkontakte_share(name = "Vkontakte", &block)
+    share_link_to name, :vkontakte, [:title, :description, :image], &block
+  end
+
+  def link_to_odnoklassniki_share(name = "Odnoklassniki", &block)
+    share_link_to name, :odnoklassniki, [:title, :description], &block
+  end
+
+  def link_to_twitter_share(name = "Twitter", &block)
+    share_link_to name, :twitter, [:title, :description], &block
+  end
+
+  # @share@ya-target.share_button.tw data-network="twitter"       data-target='bot.share_match.tw' a
+  # @share@ya-target.share_button.fb data-network="facebook"      data-target='bot.share_match.fb' b
+  # @share@ya-target.share_button.vk data-network="vkontakte"     data-target='bot.share_match.vk' ;
+  # @share@ya-target.share_button.ok data-network="odnoklassniki" data-target='bot.share_match.ok' .
+
+  private
+
+  def share_link_to(name_or_options = nil, network = nil, data_params = [], &block)
+    params = sharing_tags[network]
+    data_attrs = params.get(*(data_params +[:network, :share_url]))
+
+    if block_given?
+      name_or_options = {} if !name_or_options || name_or_options.is_a?(String)
+      data_attrs.merge!(name_or_options.delete(:data)) if name_or_options[:data]
+
+      if name_or_options[:role]
+        name_or_options[:role] += " sharing_tags_share"
+      else
+        name_or_options[:role] = "sharing_tags_share"
+      end
+
+      name_or_options.merge!(data: data_attrs, target: "_blank")
+
+      link_to params.page_url, name_or_options, &block
+    else
+      link_to name_or_options, params.page_url, data: data_attrs, role: "sharing_tags_share", target: "_blank", &block
+    end
+  end
+
+end

data/lib/sharing_tags/config.rb

@@ -0,0 +1,33 @@
+require "hashie/mash"
+
+module SharingTags
+  class Config < ::Hashie::Mash
+
+    # todo: initialize default param as Config.new
+
+    # note: temporary code for working construction sharing_tags.switch_context_to
+    def switch_context_to(name, *attrs)
+      Rails.logger.debug "SharingTags: switch context from #{SharingTags.config.current_context.name} to #{name}"
+      SharingTags.config.switch_context(name, *attrs)
+    end
+
+    def divide_by_keys(lists)
+      second_part = self.class.new
+
+      lists.each do |divide_key|
+        second_part[divide_key] =
+            if self.key?(divide_key)
+              self.delete(divide_key)
+            else
+              self.class.new
+            end
+      end
+
+      [second_part, self]
+    end
+
+    def get(*keys)
+      dup.select { |key, _| keys.include?(key.to_sym) }
+    end
+  end
+end

data/lib/sharing_tags/configuration.rb

@@ -0,0 +1,80 @@
+module SharingTags
+  class Configuration
+
+    NETWORKS = %i{ google facebook twitter }
+
+    def initialize
+      clear!
+    end
+
+    def context(name, &block)
+      raise "please define context block params" unless block_given?
+      (@contexts[name] ||= Context.new(name, self)).instance_exec(&block)
+    end
+
+    def switch_context(name = nil, *args)
+      clean_params!
+      @current_context_params = args
+      @prev_context = current_context
+
+      @current_context =
+        if name
+           @contexts[name]
+        else
+          default_context
+        end
+    end
+    alias switch_context_to switch_context
+
+    def clear!
+      @contexts = {}
+      @default_context = Context.new(:default, self)
+      @current_context = nil
+      @running_context = nil
+      clean_params!
+    end
+
+    def params
+      # @params ||= fetch_params
+      @params = fetch_params
+    end
+
+    def within_context_params(running_context_instance)
+      @running_context = running_context_instance
+      params
+    end
+
+    def running_context
+      @running_context
+    end
+
+    def current_context
+      @current_context || default_context
+    end
+
+    def clean_params!
+      @params = nil
+    end
+
+    def clear_context!
+      @current_context = nil
+    end
+
+    private
+
+    def fetch_params
+      default_context_params = default_context.params(@current_context_params)
+      return default_context_params unless @current_context
+      @current_context.params(@current_context_params, default_context_params)
+    end
+
+    def method_missing(method_name, *arguments, &block)
+      current_context.send(method_name, *arguments, &block)
+    end
+
+    def default_context
+      @default_context
+    end
+
+  end
+end

data/lib/sharing_tags/context.rb

@@ -0,0 +1,96 @@
+module  SharingTags
+  class Context
+
+    attr_reader :name
+    attr_reader :configuraton
+
+    def initialize(name, configuraton)
+      @name = name
+      @networks = {}
+      @configuraton = configuraton
+
+      Network.lists.each do |name|
+        self.send(name)
+      end
+    end
+
+    def [](network)
+      @networks[network]
+    end
+
+    def twitter(&block)
+      (@networks[:twitter] ||=  Network.new(:twitter, self)).tap do |twitter|
+        twitter.instance_exec(&block) if block_given?
+      end
+    end
+
+    def facebook(&block)
+      (@networks[:facebook] ||=  Network::Facebook.new(:facebook, self)).tap do |facebook|
+        facebook.instance_exec(&block) if block_given?
+      end
+    end
+
+    def google(&block)
+      (@networks[:google] ||=  Network.new(:google, self)).tap do |google|
+        google.instance_exec(&block) if block_given?
+      end
+    end
+
+    def vkontakte(&block)
+      (@networks[:vkontakte] ||=  Network.new(:vkontakte, self)).tap do |vkontakte|
+        vkontakte.instance_exec(&block) if block_given?
+      end
+    end
+
+    def odnoklassniki(&block)
+      (@networks[:odnoklassniki] ||=  Network.new(:odnoklassniki, self)).tap do |vkontakte|
+        vkontakte.instance_exec(&block) if block_given?
+      end
+    end
+
+    def params(context_args = nil, default_config_params = Config.new)
+      @context_params = fetch_params(context_args, default_config_params)
+    end
+
+    def default_network
+      @default_network ||= Network.new(:default, self)
+    end
+
+    private
+
+    def fetch_params(context_args = nil, default_config_params = Config.new)
+      default_context_params = fetch_default_context_params(context_args, default_config_params || Config.new)
+
+      @networks.inject(Config.new) do |result, (name, network)|
+        param = (result[name] ||= Config.new)
+
+        default_network_params = default_context_params[name]
+        param.deep_update network.attributes_for(context_args, default_network_params)
+
+        result[name] = param
+        result
+      end
+    end
+
+    def fetch_default_context_params(context_args = nil, default_config_params = Config.new)
+      # divide networks_default_params into to groups default network params and context params
+      context_default_params, config_network_defaults = default_config_params.divide_by_keys(Network.lists)
+
+      context_network_defaults = default_network.attributes_for(context_args, config_network_defaults)
+
+      context_default_params.each_value do |params|
+        params.deep_update(context_network_defaults)
+      end
+
+      context_default_params
+    end
+
+    def method_missing(method_name, *arguments, &block)
+      unless default_network.class.available_attributes.include?(method_name.to_sym)
+        raise Network::Error.new("Error didn't find #{method_name} attribute in network")
+      end
+      default_network.send(method_name, *arguments, &block)
+    end
+
+  end
+end

data/lib/sharing_tags/engine.rb

@@ -0,0 +1,6 @@
+module SharingTags
+  class Engine < ::Rails::Engine
+    isolate_namespace SharingTags
+
+  end
+end

data/lib/sharing_tags/network/facebook.rb

@@ -0,0 +1,14 @@
+module SharingTags
+  class Network::Facebook < Network
+
+    def self.available_attributes
+      super + %i( app_id )
+    end
+
+    def app_id(app_id = nil, &block)
+      attributes[:app_id] = store_value(app_id, &block)
+    end
+
+  end
+
+end

data/lib/sharing_tags/network.rb

@@ -0,0 +1,102 @@
+module SharingTags
+  class Network
+
+    class Error < StandardError
+    end
+
+    NETWORKS = %i( facebook google twitter vkontakte odnoklassniki )
+
+    ATTRIBUTES = %i( share_url title description image_url image page_url share_url_params link_params )
+
+    attr_reader :name, :attributes
+
+    autoload :Facebook,   'sharing_tags/network/facebook'
+
+    def self.lists
+      NETWORKS
+    end
+
+    def initialize(name, context = nil)
+      @name = name
+      @context = context
+      @attributes = {}
+      @share_url_params = nil
+    end
+
+    def self.available_attributes
+      ATTRIBUTES
+    end
+
+    def share_url(url = nil, &block)
+      attributes[:share_url] = store_value(url, &block)
+    end
+
+    def title(new_title = nil, &block)
+      attributes[:title] = store_value(new_title, &block)
+    end
+
+    def description(value = nil, &block)
+      attributes[:description] = store_value(value, &block)
+    end
+
+    def image_url(new_image = nil, size = nil, content_type = nil, &block)
+      attributes[:image] = store_value(new_image, &block)
+
+      # add size and content type for block value
+      size, content_type = new_image, size if block_given?
+
+      attributes[:image_size] = store_value(size.split("x")) if size
+      attributes[:image_content_type] = store_value(content_type) if content_type
+    end
+    alias :image :image_url
+
+    # todo: add image_size
+    # todo: add_image_type
+
+    def page_url(new_url = nil, &block)
+      attributes[:page_url] = store_value(new_url, &block)
+    end
+
+    def share_url_params(params = nil, &block)
+      @share_url_params = store_value(params, &block)
+    end
+    alias :link_params :share_url_params
+
+    def attributes_for(context_params = nil, default_params = Config.new)
+      # todo: merge default params after get all values of attributes
+      @attributes.inject(default_params.dup) do |result, (name, value)|
+        result[name] = get_value(value, context_params)
+        result
+      end.tap do |attrs|
+        #todo: fix assign share_url from page_url
+        attrs[:share_url] = attrs[:page_url].dup if !attrs[:share_url] && attrs[:page_url]
+        attrs[:share_url] = ("#{attrs[:share_url]}?" + @share_url_params.to_query) if attrs[:share_url] && @share_url_params
+
+        attrs[:network] = name if attrs.present?
+      end
+    end
+
+    protected
+
+    def store_value(val, &block)
+      if block_given?
+        block
+      else
+        val
+      end
+    end
+
+    def get_value(value, context_params)
+      if value.is_a?(Proc)
+        if running_context = @context.configuraton.running_context
+          # execute proc within the view context with context_params
+          running_context.instance_exec(*context_params, &value)
+        else
+          value.call(context_params)
+        end
+      else
+        value
+      end
+    end
+  end
+end

data/lib/sharing_tags/railtie.rb

@@ -0,0 +1,29 @@
+module SharingTags
+  class Railtie < Rails::Railtie
+
+    # config.eager_load_namespaces << SharingTags
+
+    generators do
+      require "generators/sharing_tags/install/install_generator"
+    end
+
+    # rake_tasks do
+    #   load "rspec/rails/tasks/rspec.rake"
+    # end
+
+    initializer "sharing_tags.configure_view_controller" do |app|
+      ActiveSupport.on_load :action_view do
+        include SharingTags::ActionView::Helpers
+      end
+
+      ActiveSupport.on_load :action_controller do
+        include SharingTags::ActionController::Helpers
+        include SharingTags::ActionController::Filters
+
+        # todo add filter for clear context
+        # append_filter :clear_context!
+      end
+    end
+
+  end
+end

data/lib/sharing_tags/version.rb

@@ -0,0 +1,3 @@
+module SharingTags
+  VERSION = "0.0.2"
+end

data/lib/sharing_tags.rb

@@ -0,0 +1,37 @@
+require "sharing_tags/engine"
+
+module SharingTags
+
+  #extend ActiveSupport::Autoload
+
+  autoload :VERSION,        'sharing_tags/version'
+  autoload :Config,         'sharing_tags/config'
+  autoload :Configuration,  'sharing_tags/configuration'
+  autoload :Network,        'sharing_tags/network'
+  autoload :Context,        'sharing_tags/context'
+
+
+  module ActionView
+    autoload :Helpers, 'sharing_tags/action_view/helpers'
+  end
+
+  module ActionController
+    autoload :Helpers, 'sharing_tags/action_controller/helpers'
+    autoload :Filters, 'sharing_tags/action_controller/filters'
+  end
+
+  def configure(&block)
+    config.clear! # cleanup config before calling configure
+    config.instance_exec(&block)
+  end
+  module_function :configure
+
+  def config
+    @config ||= Configuration.new
+  end
+  module_function :config
+
+end
+
+require 'sharing_tags/railtie' if defined?(Rails::Railtie)
+require 'sharing_tags/engine' if defined?(Rails)

data/sharing_tags.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sharing_tags/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sharing_tags"
+  spec.version       = SharingTags::VERSION
+  spec.authors       = ["Anatoliy Kovalchuk"]
+  spec.email         = ["kr00lix@gmail.com"]
+  spec.summary       = %q{ Generate sharing tags for different contexts }
+  spec.description   = %q{ Describe your sharing information for different contexts in one simple configuration file. }
+  spec.homepage      = "https://github.com/Kr00lIX/sharing_tags"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails', "~> 4.0"
+  spec.add_dependency 'hashie', "~> 3.4"
+  spec.add_dependency 'slim', "~> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "rspec-nc", "~> 0.2"
+  spec.add_development_dependency 'rspec-rails', "~> 3.2"
+  spec.add_development_dependency 'rspec-html-matchers', "~> 0.7"
+  spec.add_development_dependency 'ammeter',  '1.1.2'
+  spec.add_development_dependency "guard", "~> 2.12"
+  spec.add_development_dependency "guard-rspec", "~> 4.5"
+  spec.add_development_dependency 'sqlite3', "~> 1.3"
+  spec.add_development_dependency 'pry', "~> 0.10"
+
+end