augury 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0202c829a5e6fdfb712f3cf87ea3a340d2242ed6c86a328ab6fefce9c255963d
-  data.tar.gz: 2a90f740ab640843302ae6bc5e767c6d2f486d3c9ff060c200f8721ada5c16bd
+  metadata.gz: 5bfe458d2f8431e98c03bef3fd02e3110cc0a3be14523a468dca050f3ea1c478
+  data.tar.gz: d758020f0f3281a559a48237fe17edf9a9600c7d7072a11c5597ae038fd7b07c
 SHA512:
-  metadata.gz: 3c91a52995151ac50e642785bafe6247e79598eacda3ad32c3fd0ae8331b48596c6567342b17a11918761dff5da2ff2dbdd2544ec16643db666121689f95675f
-  data.tar.gz: 7c77c6c70e749e3c7f703a089554f686e3c7a1383c4f651a38a490b5f3c6244e28b658053a5bde478499e1994c6321817cd28ca6c8545b768a2fe83e2f72279d
+  metadata.gz: b756e409e7d664fe41e85394979f126ae43c623e7b98a8e1c214916fa18860664f1431a485fa8d210798eccf2165b944cc646d577ff76c00a77513f2ef146834
+  data.tar.gz: 79250c0549f60c415bdf476f16faf41bccc3f8dd05f97f44b1bbd9aab25508e0beff1e51bb3cebbf71a228cc767ed884f4f66b618a25e15c4dcfc4f44d530ac2

data/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

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    augury (1.0.2)
-      facets (~> 3.0)
+    augury (1.1.0)
       thor (~> 1.0.0)
       twitter (~> 7.0)
+      word_wrap (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
+    ast (2.4.2)
     awesome_print (1.8.0)
     backport (1.1.2)
     benchmark (0.1.1)
@@ -21,12 +21,11 @@ GEM
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
-    docile (1.3.4)
+    docile (1.3.5)
     domain_name (0.5.20190701)
       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)
@@ -40,8 +39,8 @@ GEM
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
-    http-parser (1.2.2)
-      ffi-compiler
+    http-parser (1.2.3)
+      ffi-compiler (>= 1.0, < 2.0)
     http_parser.rb (0.6.0)
     jaro_winkler (1.5.4)
     kramdown (2.3.0)
@@ -58,7 +57,7 @@ GEM
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
     parallel (1.20.1)
-    parser (2.7.2.0)
+    parser (3.0.0.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -102,7 +101,7 @@ GEM
       rubocop-ast (>= 0.5.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.4.0)
+    rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
     rubocop-rake (0.5.1)
       rubocop
@@ -111,13 +110,13 @@ GEM
       rubocop-ast (>= 0.7.1)
     ruby-progressbar (1.11.0)
     simple_oauth (0.3.1)
-    simplecov (0.21.1)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.2)
-    solargraph (0.40.1)
+    solargraph (0.40.2)
       backport (~> 1.1)
       benchmark
       bundler (>= 1.17.2)
@@ -125,7 +124,7 @@ GEM
       jaro_winkler (~> 1.5)
       kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.1)
-      parser (~> 2.3)
+      parser (~> 3.0)
       reverse_markdown (>= 1.0.5, < 3)
       rubocop (>= 0.52)
       thor (~> 1.0)
@@ -150,10 +149,11 @@ GEM
     unf_ext (0.0.7.7)
     unicode-display_width (1.7.0)
     vcr (6.0.0)
-    webmock (3.11.0)
+    webmock (3.11.1)
       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

data/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.

data/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

data/lib/augury/cli.rb

@@ -16,7 +16,7 @@ module Augury
     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 @@ module Augury
       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 @@ module Augury
       defaults = Thor::CoreExt::HashWithIndifferentAccess.new(
         {
           width: 72,
-          append: false,
           count: 200,
-          retweets: false,
-          replies: false,
-          links: false,
-          attribution: false,
         },
       )
 
@@ -78,6 +83,9 @@ module Augury
         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

data/lib/augury/exception.rb

@@ -6,4 +6,10 @@ module Augury
       '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

data/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 @@ module Augury
       @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 @@ module Augury
       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 @@ module Augury
         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

data/lib/augury/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: augury
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Clayton Parker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-23 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: facets
+  name: word_wrap
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
 description: This gem turns a twitter feed into a fortune file that you can use with
   the fortune program
 email: