Merge pull request #10 from claytron/formatting

Add text transformation options

Author: claytron

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changes
 
+## 1.1.0 (2020-01-24)
+
+- Add ability to transform tweet text with find / replace
+- Get full text of tweets, not the default abbreviated version
+- Switch to better word wrapping library
+
 ## 1.0.3 (2020-01-23)
 
 - Pin Thor version to avoid issue with `options` override

Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    augury (1.0.3)
-      facets (~> 3.0)
+    augury (1.1.0)
       thor (~> 1.0.0)
       twitter (~> 7.0)
+      word_wrap (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -26,7 +26,6 @@ GEM
       unf (>= 0.0.5, < 1.0.0)
     e2mmap (0.1.0)
     equalizer (0.0.11)
-    facets (3.1.0)
     ffi (1.14.2)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
@@ -154,6 +153,7 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    word_wrap (1.0.0)
     yard (0.9.26)
 
 PLATFORMS

README.md

@@ -107,7 +107,11 @@ Option | Description | Default
 `retweets` | Include retweets. | `false`
 `replies` | Include replies. | `false`
 `links` | Include tweets with links in them. | `false`
+`remove_links` | Remove all links from tweets before any other `transforms`. If set, this infers `links` is `true`. | `false`
 `attribution` | Add an author attribution to each fortune. | `false`
+`apply_transforms` | Apply the global and feed specific transforms. | `false`
+`transforms` | Transformations to apply to specific user feeds. See [Transforms](#transforms) below. |
+`global-transforms` | Transformations to apply to all feeds. Applied after `transforms` See [Transforms](#transforms) below. |
 
 ### Twitter Setup
 
@@ -126,6 +130,65 @@ twitter:
   access_token_secret: YOUR_ACCESS_TOKEN_SECRET
 ```
 
+### Transforms
+
+Global substitutions can be made using regular expressions.
+Each transform is a pattern and replacement.
+For instance, if you wanted to replace all `Hello`'s with `Hello world`, you could add the following:
+
+```yaml
+global-transforms:
+  -
+    - !ruby/regexp /(hello)/i
+    - "\\1 world"
+```
+
+Global transforms are applied after all other `transforms`.
+Word wrapping is applied after the transforms have been applied.
+
+#### Feed specific
+
+Transforms can also be defined per user feed.
+If you wanted to do the same as the global above, but only for `seinfeldtoday`, then add the following:
+
+```yaml
+transforms:
+  seinfeldtoday:
+    -
+      - !ruby/regexp /(hello)/i
+      - "\\1 world"
+```
+
+Or a more interesting example using the example earlier for `seinfeldtoday`:
+
+```text
+Elaine has no idea what her BF does for a living and it's now too
+late to ask. E:"Teacher, I think. Or a doctor? Wait Is
+'computers' a job?"
+```
+
+Then add the following to make this a bit more readable:
+
+```yaml
+transforms:
+  seinfeldtoday:
+    -
+      - !ruby/regexp /(E:\s*)/
+      - "\n\nElaine: "
+    -
+      - !ruby/regexp /BF/
+      - "boyfriend"
+```
+
+Then we end up with this:
+
+```text
+Elaine has no idea what her boyfriend does for a living and it's now
+too late to ask.
+
+Elaine: "Teacher, I think. Or a doctor? Wait Is 'computers' a job?"
+```
+
 ## Usage
 
 Create a fortune for the latest *seinfeldtoday* tweets.

augury.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'thor', '~>1.0.0'
   spec.add_dependency 'twitter', '~>7.0'
   ## For the word_wrap function
-  spec.add_dependency 'facets', '~>3.0'
+  spec.add_dependency 'word_wrap', '~>1.0'
 end

lib/augury/cli.rb

@@ -16,7 +16,7 @@ class CLI < Thor
     option :append,
       type: :boolean,
       aliases: '-a',
-      desc: 'If set, the target path will be appended to instead of overwritten'
+      desc: 'If set, the target path will be appended to instead of overwritten. DEFAULT: false'
 
     option :count,
       type: :numeric,
@@ -38,11 +38,21 @@ class CLI < Thor
       aliases: '-l',
       desc: 'Include tweets with links in them. DEFAULT: false'
 
+    option :remove_links,
+      type: :boolean,
+      aliases: '--remove-links',
+      desc: 'Remove links from tweets. DEFAULT: false'
+
     option :attribution,
       type: :boolean,
       aliases: '-A',
       desc: 'Add an author attribution to each fortune. DEFAULT: false'
 
+    option :apply_transforms,
+      type: :boolean,
+      aliases: '-t',
+      desc: 'Apply transforms from config file. DEFAULT: false'
+
     def generate(username, *path)
       path = File.expand_path(path[0] || username)
       augury = Augury::Fortune.new(username, path, options)
@@ -63,12 +73,7 @@ def options
       defaults = Thor::CoreExt::HashWithIndifferentAccess.new(
         {
           width: 72,
-          append: false,
           count: 200,
-          retweets: false,
-          replies: false,
-          links: false,
-          attribution: false,
         },
       )
 
@@ -78,6 +83,9 @@ def options
         defaults = defaults.merge(config_options)
       end
 
+      # Enforce implied options
+      defaults[:links] = true if original_options[:remove_links] || defaults[:remove_links]
+
       Thor::CoreExt::HashWithIndifferentAccess.new(defaults.merge(original_options))
     end
   end

lib/augury/exception.rb

@@ -6,4 +6,10 @@ def message
       'No twitter credential configuration found in the augury config'
     end
   end
+
+  class TransformError < StandardError
+    def message
+      'Augury transforms are invalid, check your configuration'
+    end
+  end
 end

lib/augury/fortune.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'cgi'
-require 'facets/string/word_wrap'
+require 'word_wrap'
 require 'twitter'
 
 module Augury
@@ -30,6 +30,7 @@ def retrieve_tweets
       @tweets = collect_with_max_id do |max_id|
         options = {
           count: 200,
+          tweet_mode: 'extended',
           include_rts: @config[:retweets],
           exclude_replies: !@config[:replies],
         }
@@ -46,7 +47,14 @@ def format_fortune
       filtered = @tweets.flat_map(&:full_text).reject do |tweet|
         tweet.match(/https?:/) unless @config[:links]
       end
-      formatted = filtered.flat_map { |tweet| CGI.unescapeHTML(tweet).word_wrap(@config[:width]) }
+      to_transform = transforms
+      formatted = filtered.flat_map do |tweet|
+        text = CGI.unescapeHTML(tweet)
+        to_transform.each do |transform|
+          text.gsub!(transform[0], transform[1])
+        end
+        WordWrap.ww text, @config.fetch(:width, 72)
+      end
       author = @config[:attribution] ? "\n-- #{@twitter.user(@username).name}\n" : ''
       formatted.join("#{author}%\n")
     end
@@ -75,5 +83,28 @@ def twitter_setup
         cfg.access_token_secret = @config[:twitter]['access_token_secret']
       end
     end
+
+    private
+
+    def transforms
+      all_transforms = []
+      all_transforms << [/https?:\/\/[^\s]+/, ''] if @config[:remove_links]
+      return all_transforms unless @config[:apply_transforms]
+
+      all_transforms.push(*@config.dig('transforms', @username) || [])
+      all_transforms.push(*@config.fetch('global-transforms', []))
+
+      raise Augury::TransformError unless validate_transforms(all_transforms)
+
+      all_transforms
+    end
+
+    def validate_transforms(all_transforms)
+      all_transforms.all? do |transform|
+        transform.count == 2 &&
+          [String, Regexp].include?(transform[0].class) &&
+          transform[1].is_a?(String)
+      end
+    end
   end
 end

lib/augury/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Augury
-  VERSION = '1.0.3'
+  VERSION = '1.1.0'
 end