cchardet 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79caccb90dff4c75480521201b58e917391cd7aa456b4d07734a627364ec8005
-  data.tar.gz: e8f9e53f10e87ef646dcee859bbd97cd77ace093ffee8c23da8e3efdadd9efc2
+  metadata.gz: 15c796c93834634e0aa4c71da57950fc7a42d43a3a28766d43fd7cf7103936a5
+  data.tar.gz: 581baba4d7dc98eb5720933125fdcb47c24272456fbe5cfb3a8b609c42916d0b
 SHA512:
-  metadata.gz: d8fb41ab84b626fa1da30517ce706ec89aad3f61652865fcea6d6d4293f4b431d7ea5d37d490fa5e2bb29f6f2e00f99c1a465544a9565c2900aa6518b2b83811
-  data.tar.gz: 62a8ee2996e8315115436b4ab0cbec41f3af658eb0778f7252d02dbc35f1567445a57622d80c6a5a14200225cb5a0080853dbfc1eaa2ac23cdc65b382a2e73db
+  metadata.gz: 3e40197160218e7893d5250cd2c6504d8cbd128d4ff8ade21c0621d80a3faa6498070285dbfa4247363c63a7b66252fcc5c0b06bba86cf669af9937337444f4f
+  data.tar.gz: c66c7db53e896f9b609477fed8f67038c9a9143442e563bd79b3ac1ab8fa1cefff709b1c2fd988f098ae853ad246c755402529d9833ee7f8ada8abd2f27f909b

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.2.1
+  - No functional changes
+  - Fix source URL in gemspec
+  - Relicense under MIT License. RubyGems recommends using a SPDX-listed license and public domain does not satisfy that.
+
 0.2.0
   - First functional release
 

data/README.md

@@ -1,35 +1,84 @@
-# Cchardet
+# cchardet
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cchardet`. To experiment with that code, run `bin/console` for an interactive prompt.
+Ruby bindings for freedesktop.org's uchardet (<https://gitlab.freedesktop.org/uchardet/uchardet>).
 
-TODO: Delete this and the text above, and describe your gem
+By default, this gem depends on the system uchardet. Alternatively, it can build
+the unreleased `wip/Jehan/improved-API` branch of uchardet as a native extension.
+Note that uchardet's license terms may differ from those of this gem.
 
 ## Installation
 
+### System uchardet
+
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'cchardet'
+gem "cchardet"
 ```
 
 And then execute:
 
-    $ bundle install
+```
+bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install cchardet
+```
+gem install cchardet
+```
+
+### Unreleased branch as native extension
+
+When using bundler:
+
+```
+bundle config set --global build.cchardet --with-unreleased-uchardet
+bundle install
+```
+
+When using gem directly:
+
+```
+gem install cchardet -- --with-unreleased-uchardet
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require "cchardet"
+
+# ...
+
+CChardet.detect(unknown_bytes)
+# released uchardet:
+#   { encoding: "UTF-8" }
+# unreleased native extension:
+#   { encoding: "UTF-8", confidence: 1.0, language: nil }
+```
 
-## Development
+The only public interface is `CChardet.detect`, which takes a sequence of bytes.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+When using a released version of uchardet, it will return a hash with a single
+element, `encoding`, indicating the detected encoding of the byte stream. Future
+versions of uchardet are likely to provide additional fields (see <https://gitlab.freedesktop.org/uchardet/uchardet/-/issues/5#note_474963>).
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+When using the unreleased native extension, it will return an array of hashes
+having three elements:
+
+- `encoding` – Detected encoding of the byte stream
+- `confidence` – Confidence of the encoding value
+- `language` – Detected language, if known
+
+The hashes are ordered by descending confidence.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cchardet.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/elebow/cchardet>.
+
+## License
+
+MIT License.
+
+Note that uchardet, which may be compiled as a native extension, is covered by its
+own license.

data/cchardet.gemspec

@@ -9,12 +9,12 @@ Gem::Specification.new do |spec|
   spec.email         = ["elebow@users.noreply.github.com"]
 
   spec.summary       = "Ruby bindings for freedesktop.org's libuchardet, for encoding detection."
-  spec.homepage      = "https://github.com/elebow/cchardet"
-  spec.license       = "public domain"
+  spec.homepage      = "https://github.com/elebow/cchardet-ruby"
+  spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/elebow/cchardet"
+  spec.metadata["source_code_uri"] = "https://github.com/elebow/cchardet-ruby"
   spec.metadata["changelog_uri"] = "https://github.com/elebow/cchardet/blob/trunk/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.

data/lib/cchardet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CChardet
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: cchardet
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Eddie Lebow
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-01 00:00:00.000000000 Z
+date: 2021-03-08 00:00:00.000000000 Z
 dependencies: []
-description:
+description: 
 email:
 - elebow@users.noreply.github.com
 executables: []
@@ -333,14 +333,14 @@ files:
 - lib/cchardet.rb
 - lib/cchardet/lib_finder.rb
 - lib/cchardet/version.rb
-homepage: https://github.com/elebow/cchardet
+homepage: https://github.com/elebow/cchardet-ruby
 licenses:
-- public domain
+- MIT
 metadata:
-  homepage_uri: https://github.com/elebow/cchardet
-  source_code_uri: https://github.com/elebow/cchardet
+  homepage_uri: https://github.com/elebow/cchardet-ruby
+  source_code_uri: https://github.com/elebow/cchardet-ruby
   changelog_uri: https://github.com/elebow/cchardet/blob/trunk/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -355,8 +355,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
 specification_version: 4
 summary: Ruby bindings for freedesktop.org's libuchardet, for encoding detection.
 test_files: []