twitter-text 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92e1f709304c7902186bbe50ff5f7d215059d292a4e8730b9cdff12210dff1aa
-  data.tar.gz: fd50deede86bb5ba1a47ff214350f86a928ed59926438d3361475f3640ff8531
+  metadata.gz: 51743434be1b2fd825f0a9ae3dbcc97c0c5fab245dad7f012a9c92e3cc7d1e00
+  data.tar.gz: 1571db93e87a73048c4bd7e9940d7c7158f5a02d044fc9a759593e3617a248ec
 SHA512:
-  metadata.gz: 85f39c5bd4d9c58b863d5e9490618ee941a528ab8fd23a463857a206d53ba50a4235cb7e287245a0e3bb66bb78955b98cf6973f1ed5e2ec5741090ef34a77c52
-  data.tar.gz: 6a0133f3acd0a34742435777f4fc276df4639066adc80b39d3a4b84f77ec73eb0772fae0ff52f20e3af752b089ca976de3b215d83241944c2fd0ef8f9823ba85
+  metadata.gz: d4189f84389d8ad9c51752a111adc1616d4d1a4063dfa265a492a1d0f0196af785e41e1bce8ea3b6c42aee856b9ccd19f714a9947ae4fce0be7b5d3ed4cd1048
+  data.tar.gz: 2026f92f4249c6c0a4cbaa92cac145356edb0adf617e0fc5f3e8fb66ca3eb5a22e9372387997adf4220799270854dc062e444f0858ab7abb802b6b3f7d8f16da

data/Rakefile

@@ -2,9 +2,18 @@ require 'bundler'
 include Rake::DSL
 Bundler::GemHelper.install_tasks
 
-task :default => ['spec', 'test:conformance']
+task :build => ['prebuild']
+task :spec => ['prebuild']
+task :default => ['prebuild', 'spec', 'test:conformance']
 task :test => :spec
 
+directory "config"
+
+desc "Prebuild task setup"
+task :prebuild => ["config"] do
+  FileUtils.cp_r '../config/.', 'config', :verbose => true
+end
+
 require 'rubygems'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
@@ -12,7 +21,7 @@ RSpec::Core::RakeTask.new(:spec)
 namespace :test do
   namespace :conformance do
     desc "Run conformance test suite"
-    task :run do
+    task :run => ['prebuild'] do
       ruby '-rubygems', "test/conformance_test.rb"
     end
   end
@@ -34,3 +43,8 @@ end
 desc "Run cruise control build"
 task :cruise => [:spec, 'test:conformance'] do
 end
+
+desc "Clean build"
+task :clean do
+  rm_rf ["config", "pkg", "Gemfile.lock"]
+end

data/config/README.md

@@ -0,0 +1,134 @@
+# twitter-text Configuration
+
+twitter-text 2.0 introduces a new configuration format as well as APIs
+for interpreting this configuration. The configuration is a JSON
+string (or file) and the parsing APIs have been provided in each of
+twitter-text’s four reference languages.
+
+## Format
+
+The configuration format is a JSON string. The JSON can have the following properties:
+
+* `version` (required, integer, min value 0)
+* `maxWeightedTweetLength` (required, integer, min value 0)
+* `scale` (required, integer, min value 1)
+* `defaultWeight` (required, integer, min value 0)
+* `transformedURLLength` (integer, min value 0)
+* `ranges` (array of range items)
+
+A `range item` has the following properties:
+
+* `start` (required, integer, min value 0)
+* `end` (required, integer, min value 0)
+* `weight` (required, integer, min value 0)
+
+## Parameters
+
+### version
+
+The version for the configuration string. This is an integer that will
+monotonically increase in future releases. The legacy version of the
+string is version 1; weighted code point ranges and 280-character
+“long” tweets are supported in version 2.
+
+### maxWeightedTweetLength
+
+The maximum length of the tweet, weighted. Legacy v1 tweets had a
+maximum weighted length of 140 and all characters were weighted the
+same. In the new configuration format, this is represented as a
+maxWeightedTweetLength of 140 and a defaultWeight of 1 for all code
+points.
+
+### scale
+
+The Tweet length is the (`weighted length` / `scale`).
+
+### defaultWeight
+
+The default weight applied to all code points. This is overridden in
+one or more range items.
+
+### transformedURLLength
+
+The length counted for URLs against the total weight of the Tweet. In
+previous versions of twitter-text, which was the “shortened URL
+length.” Differentiating between the http and https shortened length
+for URLs has been deprecated (https is used for all t.co URLs). The
+default value is 23.
+
+### ranges
+
+An array of range items that describe ranges of Unicode code points
+and the weight to apply to each code point. Each range is defined by
+its start, end, and weight. Surrogate pairs have a length that is
+equivalent to the length of the first code unit in the surrogate
+pair. Note that certain graphemes are the result of joining code
+points together, such as by a zero-width joiner; unlike a surrogate
+pair, the length of such a grapheme will be the sum of the weighted
+length of all included code points.
+
+## API
+
+Each of the four reference language implementations provides a way to
+read the JSON configuration.
+
+## Java
+
+```java
+public static TwitterTextConfiguration configurationFromJson(@Nonnull String json, boolean isResource)
+```
+
+`json`: the configuration string or file name in the config directory (see `isResource`)
+`isResource`: if true, json refers to a file name for the configuration.
+
+## JavaScript
+
+Configurations are accessed via `twttr.text.configs` (example:
+`twttr.text.configs.version2`). This config is passed as an argument
+to `parseTweet:`
+
+```js
+twttr.txt.parseTweet(inputText, configVersion2)
+```
+
+## Objective-C
+
+The Objective-C implementation provides two methods for reading the
+input, either from a string or a file resource.
+
+```objective-c
++ (instancetype)configurationFromJSONResource:(NSString *)jsonResource;
++ (instancetype)configurationFromJSONString:(NSString *)jsonString;
+```
+
+The default configuration can also be set:
+
+```objective-c
++ (void)setDefaultParserConfiguration:(TwitterTextConfiguration *)configuration
+```
+
+The resource string refers to the two included configuration files
+(which are referenced in the Xcode project).
+
+## Ruby
+
+Ruby provides the `Twitter::Configuration` class and means to read
+from a file or string.
+
+```ruby
+def self.parse_string(string, options = {})
+def self.parse_file(filename)
+```
+
+You can use `configuration_from_file()` or initialize a configuration
+using `Twitter::Configuration.new(config)`, where `config` is the
+output of one of the two above methods.
+
+
+
+
+
+
+
+
+

data/config/v1.json

@@ -0,0 +1,8 @@
+{
+  "version": 1,
+  "maxWeightedTweetLength": 140,
+  "scale": 1,
+  "defaultWeight": 1,
+  "transformedURLLength": 23,
+  "ranges": []
+}

data/config/v2.json

@@ -0,0 +1,29 @@
+{
+  "version": 2,
+  "maxWeightedTweetLength": 280,
+  "scale": 100,
+  "defaultWeight": 200,
+  "transformedURLLength": 23,
+  "ranges": [
+    {
+      "start": 0,
+      "end": 4351,
+      "weight": 100
+    },
+    {
+      "start": 8192,
+      "end": 8205,
+      "weight": 100
+    },
+    {
+      "start": 8208,
+      "end": 8223,
+      "weight": 100
+    },
+    {
+      "start": 8242,
+      "end": 8247,
+      "weight": 100
+    }
+  ]
+}

data/lib/twitter-text/configuration.rb

@@ -15,12 +15,12 @@ module Twitter
     attr_reader :default_weight, :transformed_url_length, :ranges
 
     CONFIG_V1 = File.join(
-      File.expand_path('../../../../config', __FILE__), # project root
+      File.expand_path('../../../config', __FILE__), # project root
       "#{PARSER_VERSION_CLASSIC}.json"
     )
 
     CONFIG_V2 = File.join(
-      File.expand_path('../../../../config', __FILE__), # project root
+      File.expand_path('../../../config', __FILE__), # project root
       "#{PARSER_VERSION_DEFAULT}.json"
     )
 

data/twitter-text.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "twitter-text"
-  s.version = "2.0.0"
+  s.version = "2.0.1"
   s.authors = ["David LaMacchia", "Sudheer Guntupalli", "Kaushik Lakshmikanth", "Jose Antonio Marquez Russo", "Lee Adams",
                "Yoshimasa Niwa"]
   s.email = ["opensource@twitter.com"]
@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   # Use of idn-ruby requires libidn to be installed separately
   s.add_runtime_dependency     "idn-ruby"
 
-  s.files         = `git ls-files`.split("\n") + ['lib/assets/tld_lib.yml']
+  s.files         = `git ls-files`.split("\n") + ['lib/assets/tld_lib.yml'] + Dir['config/*']
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twitter-text
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - David LaMacchia
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-15 00:00:00.000000000 Z
+date: 2017-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -170,6 +170,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- config/README.md
+- config/v1.json
+- config/v2.json
 - lib/assets/tld_lib.yml
 - lib/twitter-text.rb
 - lib/twitter-text/autolink.rb