yashare 0.1 → 0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ca068e99dd62b4586fe3b5b73c184588aff24a4
-  data.tar.gz: e35390cf154918c50887fa138c00e85a6a9b5a8d
+  metadata.gz: cc67f92b907766a7f421ef6ae5717ebab687ad8e
+  data.tar.gz: ba2ba0306f24d629265f24d0fc5d9405cb1c26c3
 SHA512:
-  metadata.gz: b75ad2383c5249f94446525a83cfcea562e35f9e721b237ddddfe0b92af73150fe7e2c9d97424f20813e802a001ed20b9ae50f24a6db8abe76cf8a81575e952c
-  data.tar.gz: c708455cf0c2853c3deba162e715faa8a42b7ad9644ad9f286d1dfd8267ce326f84bf12d221d7266e5820f82210976f5b2f8b6c5a599b70b272e39d76112fa19
+  metadata.gz: ee2c04093b6466caabe98116de4d862efa93ae588cea2cb5b0bb7437cca93cbc941bdd48d517f5d872426f4968e5d7e4d21d5892680d6d08ddd0fd6416662f73
+  data.tar.gz: e83bbb55bcee55e08aadf978b1699a1efa5964743053380cb2e334f8d828071d2a821d254b18f06e47c92a2fa49cd4ae2784d544d4ff7e4284ae8900e94a8bbe

data/.travis.yml

@@ -3,3 +3,6 @@ rvm:
   - 2.1.0
   - 2.0.0
   - 1.9.3
+addons:
+  code_climate:
+    repo_token: 4c98194025a5cc54de2434523819d48a9e98ad08ece8d798fc636681a3d9145a

data/README.md

@@ -1,5 +1,12 @@
 # YaShare
 
+[![Build Status](https://travis-ci.org/andrewgr/yashare.png)](https://travis-ci.org/andrewgr/yashare)
+[![Code Climate](https://codeclimate.com/github/andrewgr/yashare/badges/gpa.svg)](https://codeclimate.com/github/andrewgr/yashare)
+[![Test Coverage](https://codeclimate.com/github/andrewgr/yashare/badges/coverage.svg)](https://codeclimate.com/github/andrewgr/yashare/coverage)
+[![Gem Version](https://badge.fury.io/rb/yashare.svg)](http://badge.fury.io/rb/yashare)
+
+An Action View helper to add Yandex Share buttons to your Rails App.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,7 +23,34 @@ Or install it yourself as:
 
 ## Usage
 
-TODO
+Use `yashare` helper in your view code to add the Yandex Share buttons to the page. Without any parameters, this code
+
+    <%= yashare %>
+
+will render this HTML:
+```HTML
+<script charset="utf-8" type="text/javascript" src="//yastatic.net/share/share.js"></script>
+<div class="yashare-auto-init" data-yashareQuickServices="vkontakte,facebook,twitter,lj" data-yashareL10n="ru" data-yashareType="button"></div>
+```
+
+Use `services` option to specify buttons for which services should be displayed. The default services are: `:vkontakte`, `:facebook`, `:twitter`, `:lj`. Supported services: `:blogger`, `:delicious`, `:diary`, `:digg`, `:evernote`, `:facebook`, `:friendfeed`, `:gplus`, `:juick`, `:liveinternet`, `:linkedin`, `:lj`, `:moikrug`, `:moimir`, `:myspace`, `:odnoklassniki`, `:pinterest`, `:surfingbird`, `:tutby`, `:twitter`, `:vkontakte`, `:yazakladki`.
+
+    <%= yashare(services: [:twitter, :facebook]) %>
+
+Use `lang` option to specify the language for the buttons. The default value is `ru`. Supported values: `:az`,
+`:be`, `:en`, `:hy`, `:ka`, `:kk`, `:ro`, `:ru`, `:tr`, `:tt`, `:uk`.
+
+    <%= yashare(lang: :ru) %>
+
+Use `image` option to specify the image for sharing on Pinterest. This option is useful only when `services` option includes `:pinterest`.
+
+    <%= yashare(image: 'http://example.com/i/photo.jpg') %>
+
+Use `type` option to specify the appearance of the buttons. Default value is `:button`. Supported values: `:small`, `:button`, `:link`, `:icon`, `:none`.
+
+    <%= yashare(type: :small) %>
+
+Read Yandex Share button [documentation](https://tech.yandex.ru/share/) (in Russian) for more information.
 
 ## Contributing
 

data/lib/yashare/helpers.rb

@@ -2,17 +2,18 @@ module Yashare
   module Helpers
     extend ActiveSupport::Concern
 
-    def yashare(opts={})
-      script = content_tag(:script, nil,
+    def yashare(opts = {})
+      attrs = {
         charset: 'utf-8',
         type:    'text/javascript',
         src:     '//yastatic.net/share/share.js'
-      )
+      }
 
-      div = content_tag(:div)
+      script = content_tag(:script, nil, attrs)
+      widget = Yashare::Widget.new(self, opts)
+      html = [script, widget].join("\n")
 
-      html = [script, Yashare::Widget.new(self, opts)].join("\n")
-      self.raw(html)
+      raw(html)
     end
   end
 end

data/lib/yashare/version.rb

@@ -1,4 +1,4 @@
 module Yashare
   # Gem version
-  VERSION = '0.1'
+  VERSION = '0.9'
 end

data/lib/yashare/widget.rb

@@ -1,36 +1,34 @@
 module Yashare
   class Widget
-    def initialize(view, opts={})
+    def initialize(view, opts = {})
       @view = view
 
-      @services = opts.fetch(:services, ['vkontakte', 'facebook', 'twitter', 'lj'])
+      @services = opts.fetch(:services, %w(vkontakte facebook twitter lj))
       @image    = opts.fetch(:image,    nil)
       @type     = opts.fetch(:type,     'button')
       @lang     = opts.fetch(:lang,     'ru')
     end
 
     def to_s
-      attrs = {
-        class: 'yashare-auto-init',
-        data: {
-          yashareL10n: lang,
-          yashareType: type,
-          yashareQuickServices: services.join(',')
-        }
-      }
-
-      if type == 'small'
-        attrs[:data][:yashareTheme] = 'counter'
-      end
+      @html ||= render
+    end
 
-      if image.present?
-        attrs[:data][:yashareImage] = image
-      end
+    private
 
-      view.content_tag(:div, nil, attrs)
+    def render
+      view.content_tag(:div, nil, class: 'yashare-auto-init', data: data_attrs)
     end
 
-    private
+    def data_attrs
+      {
+        yashareQuickServices: Array(services).join(','),
+        yashareL10n: lang,
+        yashareType: type
+      }.tap do |data|
+        data[:yashareTheme] = 'counter' if type.to_s == 'small'
+        data[:yashareImage] = image     if image.present?
+      end
+    end
 
     attr_reader :view, :type, :services, :image, :lang
   end

data/spec/spec_helper.rb

@@ -1 +1,5 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'action_view'
 require 'yashare'

data/spec/support/default.html

@@ -0,0 +1,2 @@
+<script charset="utf-8" type="text/javascript" src="//yastatic.net/share/share.js"></script>
+<div class="yashare-auto-init" data-yashareQuickServices="vkontakte,facebook,twitter,lj" data-yashareL10n="ru" data-yashareType="button"></div>

data/spec/support/with_services.html

@@ -0,0 +1,2 @@
+<script charset="utf-8" type="text/javascript" src="//yastatic.net/share/share.js"></script>
+<div class="yashare-auto-init" data-yashareQuickServices="facebook" data-yashareL10n="ru" data-yashareType="button"></div>

data/spec/yashare/helpers_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+RSpec.describe Yashare::Helpers do
+  describe '#yashare' do
+    let(:view) { ActionView::Base.new }
+
+    context 'no options specified' do
+      subject { view.yashare }
+
+      let(:expected) { File.read('./spec/support/default.html').strip }
+
+      it { is_expected.to eq(expected) }
+    end
+
+    context 'services specified' do
+      subject { view.yashare(services: :facebook) }
+
+      let(:expected) { File.read('./spec/support/with_services.html').strip }
+
+      it { is_expected.to eq(expected) }
+    end
+  end
+end

data/spec/yashare/widget_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+RSpec.describe Yashare::Widget do
+  let(:view) { ActionView::Base.new }
+
+  describe '#to_s' do
+    context 'no options specified' do
+      subject { described_class.new(view).to_s }
+
+      let(:expected) do
+        '<div
+          class="yashare-auto-init"
+          data-yashareQuickServices="vkontakte,facebook,twitter,lj"
+          data-yashareL10n="ru"
+          data-yashareType="button"></div>'.gsub(/\s+/, ' ')
+      end
+
+      it { is_expected.to eq(expected) }
+    end
+
+    context 'one service specified' do
+      subject { described_class.new(view, services: 'vkontakte').to_s }
+
+      let(:expected) do
+        '<div
+          class="yashare-auto-init"
+          data-yashareQuickServices="vkontakte"
+          data-yashareL10n="ru"
+          data-yashareType="button"></div>'.gsub(/\s+/, ' ')
+      end
+
+      it { is_expected.to eq(expected) }
+    end
+
+    context 'services specified' do
+      subject { described_class.new(view, services: ['vkontakte', 'lj']).to_s }
+
+      let(:expected) do
+        '<div
+          class="yashare-auto-init"
+          data-yashareQuickServices="vkontakte,lj"
+          data-yashareL10n="ru"
+          data-yashareType="button"></div>'.gsub(/\s+/, ' ')
+      end
+
+      it { is_expected.to eq(expected) }
+    end
+
+    context 'language specified' do
+      subject { described_class.new(view, lang: 'en').to_s }
+
+      let(:expected) do
+        '<div
+          class="yashare-auto-init"
+          data-yashareQuickServices="vkontakte,facebook,twitter,lj"
+          data-yashareL10n="en"
+          data-yashareType="button"></div>'.gsub(/\s+/, ' ')
+      end
+
+      it { is_expected.to eq(expected) }
+    end
+
+    context 'image specified' do
+      subject { described_class.new(view, image: '/img.png').to_s }
+
+      let(:expected) do
+        '<div
+          class="yashare-auto-init"
+          data-yashareQuickServices="vkontakte,facebook,twitter,lj"
+          data-yashareL10n="ru"
+          data-yashareType="button"
+          data-yashareImage="/img.png"></div>'.gsub(/\s+/, ' ')
+      end
+
+      it { is_expected.to eq(expected) }
+    end
+
+    context 'image specified' do
+      subject { described_class.new(view, type: 'small').to_s }
+
+      let(:expected) do
+        '<div
+          class="yashare-auto-init"
+          data-yashareQuickServices="vkontakte,facebook,twitter,lj"
+          data-yashareL10n="ru"
+          data-yashareType="small"
+          data-yashareTheme="counter"></div>'.gsub(/\s+/, ' ')
+      end
+
+      it { is_expected.to eq(expected) }
+    end
+  end
+end

data/yashare.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'actionpack', '~> 4'
   gem.add_development_dependency 'rubocop', '~> 0.30'
   gem.add_development_dependency 'cane', '~> 2.6', '>= 2.6.1'
+  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yashare
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.9'
 platform: ruby
 authors:
 - Andrei Gridnev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-10 00:00:00.000000000 Z
+date: 2015-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -86,6 +86,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.6.1
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 description: Add and customize Yandex Share buttons to your Rails app
 email:
 - andrew.gridnev@gmail.com
@@ -107,6 +121,10 @@ files:
 - lib/yashare/version.rb
 - lib/yashare/widget.rb
 - spec/spec_helper.rb
+- spec/support/default.html
+- spec/support/with_services.html
+- spec/yashare/helpers_spec.rb
+- spec/yashare/widget_spec.rb
 - yashare.gemspec
 homepage: https://github.com/andrewgr/yashare/
 licenses:
@@ -134,3 +152,7 @@ specification_version: 4
 summary: Yandex Share buttons for your Rails app
 test_files:
 - spec/spec_helper.rb
+- spec/support/default.html
+- spec/support/with_services.html
+- spec/yashare/helpers_spec.rb
+- spec/yashare/widget_spec.rb