bluebird 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzdhMmI0OGJlM2U2ZjEwY2IxMzg0ZmJlZmNjOTNhYzg5MTQxOWY3Yg==
+  data.tar.gz: !binary |-
+    YTA5YmQ1MjQxNWE5MzBhNjQwNzc5NzRiY2QyNzQ2MTEzNDZjZDY0YQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NTIxM2QzMGExZGYxNjY0ZTRhMmZkZDc5N2M1MDllODA2ZTliMjQzZWZiNzY4
+    ZDczYzJkNjdkN2JkZTczNTI1OGQ3OTYyYTc1ZmY5OThiZjhkYjI1ODczNTAy
+    OWU1YzIwYmJjM2M1ZTNjMmQ1OGMzNjkxZGFkZGMwZjI0YTEwMTU=
+  data.tar.gz: !binary |-
+    NzFiYTYxY2M3ZmQ4YTlmNjZhNDE4MmUwZDQzMmYxMjUxMjM4MDRjMTI1Y2Ey
+    MjIzYzU4MzE2ODU5ODJjM2UwYzUzYjRiMGQwYTgxZTk3ZTUxYjc1YzA2YTA2
+    YTdlNTRiMGJhYmMyNzVmMmRiMWFhMDhiZmIwNjE0NzU0NDdhN2Q=

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 İ. Emre Kutlu
+
+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,62 @@
+# Bluebird
+
+Bluebird modifies your tweets, mostly to fit 140 characters.  
+It uses "strategies". Every strategy makes its own modifications to the tweets.  
+It does not ensure that tweet will fit 140 characters. (More strategies will be added to ensure it.)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+````ruby
+gem 'bluebird'
+````
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bluebird
+    
+## Configuration
+
+You do not need any configuration to start using bluebird but it is intended  for a quick start. <code>characters_reserved_per_media</code>, <code>short_url_length_https</code> and <code>short_url_length</code> can change any time, **it is your duty** to fetch these values from twitter API and change bluebird configuration. For more information visit [twitter docs](https://dev.twitter.com/docs/api/1.1/get/help/configuration).
+
+
+These are the default values:
+
+````ruby
+Bluebird.configure do |config|
+  config.strategies                    = [:strip, :squeeze, :truncate_text]
+  config.max_length                    = 140
+  config.characters_reserved_per_media = 23
+  config.short_url_length_https        = 23
+  config.short_url_length              = 22
+  
+  config.truncate_text.omission        = '...'
+end
+````
+
+If you want to change defaults for Rails, create a file in <code>initializers</code> folder and copy the code above.  
+
+By default bluebird runs three strategies in these order; <code>strip</code>, <code>squeeze</code> and <code>truncate</code>. For detailed information about each strategy, visit [Strategies](https://github.com/emrekutlu/bluebird/wiki/Strategies).
+
+## Usage
+
+````ruby
+Bluebird.modify('The bluebirds are a group of medium-sized, mostly insectivorous or omnivorous birds in the genus Sialia of the thrush family (Turdidae). #bluebird #animals')
+# => 'The bluebirds are a group of medium-sized, mostly insectivorous or omnivorous birds in the genus Sialia of the thrush ... #bluebird #animals'
+````
+
+If uploading media:
+
+````ruby
+Bluebird.modify('The bluebirds are a group of medium-sized, mostly insectivorous or omnivorous birds in the genus Sialia of the thrush family (Turdidae). #bluebird #animals', media: true)
+# => 'The bluebirds are a group of medium-sized, mostly insectivorous or omnivorous birds in the genu... #bluebird #animals'
+````
+
+## License
+
+Bluebird is released under the [MIT License](https://github.com/emrekutlu/bluebird/blob/master/LICENSE.txt).

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec

data/bluebird.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bluebird/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bluebird'
+  spec.version       = Bluebird::VERSION
+  spec.authors       = ['İ. Emre Kutlu']
+  spec.email         = ['emrekutlu@gmail.com']
+  spec.description   = %q{Modifies your tweets mostly to fit 140 characters}
+  spec.summary       = %q{Modifies your tweets}
+  spec.homepage      = 'http://github.com/emrekutlu/bluebird'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_runtime_dependency 'twitter-text', '~> 1.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.1'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+end

data/lib/bluebird.rb

@@ -0,0 +1,56 @@
+require 'twitter-text'
+
+require 'bluebird/version'
+require 'bluebird/config'
+require 'bluebird/tweet'
+require 'bluebird/partial'
+require 'bluebird/strategies/base'
+require 'bluebird/strategies/strip'
+require 'bluebird/strategies/squeeze'
+require 'bluebird/strategies/truncate_text'
+
+module Bluebird
+  class << self
+
+    def configure
+      yield(Config)
+    end
+
+    def modify(status, opts = {})
+      tweet = Bluebird::Tweet.new(status, opts)
+      run_strategies(tweet)
+      tweet.status
+    end
+
+    private
+
+    def run_strategies(tweet)
+      Config.strategies.each do |strategy|
+        strategy_by_symbol(strategy).run(tweet, Config)
+      end
+    end
+
+    def symbol_to_class(symbol)
+      symbol.to_s.split('_').map do |string|
+        i = 0
+        string.chars.map do |char|
+          i += 1
+          if i.eql?(1)
+            char.upcase
+          else
+            char
+          end
+        end
+      end.join
+    end
+
+    def strategy_by_symbol(symbol)
+      strategies_module.const_get(symbol_to_class(symbol)).const_get('Strategy')
+    end
+
+    def strategies_module
+      @strategies_module ||= Object.const_get('Bluebird').const_get('Strategies')
+    end
+
+  end
+end

data/lib/bluebird/config.rb

@@ -0,0 +1,21 @@
+module Bluebird
+  class Config
+
+    @strategies                    = [:strip, :squeeze, :truncate_text]
+    @max_length                    = 140
+    @characters_reserved_per_media = 23
+    @short_url_length_https        = 23
+    @short_url_length              = 22
+
+    class << self
+      attr_accessor :strategies, :max_length, :characters_reserved_per_media, :short_url_length_https, :short_url_length
+
+      def register(name, klass)
+        singleton_class.send(:attr_accessor, name)
+        send("#{name}=", klass)
+      end
+
+    end
+
+  end
+end

data/lib/bluebird/partial.rb

@@ -0,0 +1,70 @@
+module Bluebird
+  class Partial
+
+    attr_accessor :content, :prev_partial, :next_partial
+
+    def initialize(content, partial_type)
+      @content      = content
+      @partial_type = partial_type
+    end
+
+    def length
+      if url?
+        https? ? Config.short_url_length_https : Config.short_url_length
+      else
+        content.char_length
+      end
+    end
+
+    def first?
+      !prev_partial
+    end
+
+    def last?
+      !next_partial
+    end
+
+    def text?
+      @partial_type.eql?(:text)
+    end
+
+    def mention?
+      @partial_type.eql?(:mention)
+    end
+
+    def list?
+      @partial_type.eql?(:list)
+    end
+
+    def url?
+      @partial_type.eql?(:url)
+    end
+
+    def hashtag?
+      @partial_type.eql?(:hashtag)
+    end
+
+    def cashtag?
+      @partial_type.eql?(:cashtag)
+    end
+
+    def entity?
+      !text?
+    end
+
+    def separator?
+      # separates two entities
+      # ex: @iekutlu and @mekanio => " and " is a separater
+      prev_partial && prev_partial.entity? && next_partial && next_partial.entity?
+    end
+
+    def reply_preventer?
+      first? && next_partial && next_partial.mention?
+    end
+
+    def https?
+      url? && content.start_with?('https://')
+    end
+
+  end
+end

data/lib/bluebird/strategies/base.rb

@@ -0,0 +1,13 @@
+module Bluebird
+  module Strategies
+    class Base
+      class << self
+
+        def run(tweet, config)
+          raise NotImplementedError
+        end
+
+      end
+    end
+  end
+end

data/lib/bluebird/strategies/squeeze.rb

@@ -0,0 +1 @@
+require 'bluebird/strategies/squeeze/strategy'

data/lib/bluebird/strategies/squeeze/strategy.rb

@@ -0,0 +1,29 @@
+module Bluebird
+  module Strategies
+    module Squeeze
+      class Strategy < Bluebird::Strategies::Base
+        class << self
+
+          def run(tweet, config)
+            if run?(tweet, config.max_length)
+              squeeze(tweet)
+            end
+          end
+
+          private
+
+          def run?(tweet, max)
+            tweet.length > max
+          end
+
+          def squeeze(tweet)
+            tweet.text_partials.each do |partial|
+              partial.content.squeeze!(' ')
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/bluebird/strategies/strip.rb

@@ -0,0 +1 @@
+require 'bluebird/strategies/strip/strategy'

data/lib/bluebird/strategies/strip/strategy.rb

@@ -0,0 +1,31 @@
+module Bluebird
+  module Strategies
+    module Strip
+      class Strategy < Bluebird::Strategies::Base
+        class << self
+
+          def run(tweet, config)
+            if run?(tweet, config.max_length)
+              strip(tweet)
+            end
+          end
+
+          private
+
+          def run?(tweet, max)
+            tweet.length > max
+          end
+
+          def strip(tweet)
+            first = tweet.partials.first
+            last  = tweet.partials.last
+
+            first.content.lstrip! if first.text?
+            last.content.rstrip! if last.text?
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/bluebird/strategies/truncate_text.rb

@@ -0,0 +1,4 @@
+require 'bluebird/strategies/truncate_text/strategy'
+require 'bluebird/strategies/truncate_text/config'
+
+Bluebird::Config.register(:truncate_text, Bluebird::Strategies::TruncateText::Config)

data/lib/bluebird/strategies/truncate_text/config.rb

@@ -0,0 +1,15 @@
+module Bluebird
+  module Strategies
+    module TruncateText
+      class Config
+
+        @omission = '...'
+
+        class << self
+          attr_accessor :omission
+        end
+
+      end
+    end
+  end
+end

data/lib/bluebird/strategies/truncate_text/strategy.rb

@@ -0,0 +1,147 @@
+module Bluebird
+  module Strategies
+    module TruncateText
+      class Strategy < Bluebird::Strategies::Base
+        class << self
+
+          def run(tweet, config)
+            if run?(tweet, config.max_length)
+              truncate(tweet, config.max_length)
+            end
+          end
+
+          private
+
+          def run?(tweet, max)
+            tweet.length > max
+          end
+
+          def truncate(tweet, max)
+            count = count_to_truncate(tweet, max)
+
+            if needs_truncation?(count)
+              if (suitable = suitable_partial(tweet, count))
+                truncate_partial(suitable, count)
+                add_omission(suitable)
+              else
+                truncate_partials(tweet, count)
+              end
+            end
+          end
+
+          def needs_truncation?(count)
+            count > 0
+          end
+
+          def truncate_partials(tweet, count)
+            truncatable_partials(tweet).each do |partial|
+              count -= truncate_partial(partial, count)
+              unless needs_truncation?(count)
+                add_omission(partial)
+                break
+              end
+            end
+          end
+
+          def truncate_partial(partial, count)
+            truncated_count = 0
+
+            if handle_truncation?(partial, count)
+
+              partial.content = if keep_last_space?(partial)
+                partial.content[0, partial.length - count - 1] + ' '
+              else
+                partial.content[0, partial.length - count]
+              end
+
+              truncated_count = count
+            else
+              if deletable?(partial)
+                truncated_count = partial.length
+                partial.content = ''
+              else
+                truncated_count = partial.length - 1
+                partial.content = partial.reply_preventer? ? '.' : ' '
+              end
+            end
+
+            truncated_count
+          end
+
+          def truncatable_partials(tweet)
+            tweet.text_partials.reverse
+          end
+
+          def suitable_partial(tweet, count)
+            truncatable_partials(tweet).each do |partial|
+              return partial if handle_truncation?(partial, count)
+            end
+            nil
+          end
+
+          def count_to_truncate(tweet, max)
+            tweet.length > max ? tweet.length - max : 0
+          end
+
+          def deletable?(partial)
+            !partial.separator? && !partial.reply_preventer?
+          end
+
+          def handle_truncation?(partial, count)
+            truncatable_length(partial) > count
+          end
+
+          def add_omission(partial)
+            if add_omission?
+              length = omission.char_length
+              if handle_truncation?(partial, length)
+                truncate_partial(partial, length)
+                if ends_with_space?(partial)
+                  delete_last_character(partial)
+                  partial.content += omission + ' '
+                else
+                  partial.content += omission
+                end
+              end
+            end
+          end
+
+          def add_omission?
+            omission && omission.char_length > 0
+          end
+
+          def truncatable_length(partial)
+            if partial.last?
+              partial.length
+            elsif partial.first?
+              if partial.reply_preventer?
+                partial.length - 1
+              else
+                partial.length
+              end
+            else
+              partial.length - 1
+            end
+          end
+
+          def ends_with_space?(partial)
+            partial.content.to_char_a.last.eql?(' ')
+          end
+
+          def keep_last_space?(partial)
+            ends_with_space?(partial) && partial.next_partial
+          end
+
+          def delete_last_character(partial)
+            partial.content = partial.content[0, partial.content.length - 1]
+          end
+
+          def omission
+            Bluebird::Strategies::TruncateText::Config.omission
+          end
+
+        end
+      end
+    end
+  end
+end