clocale 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 77da4c8e02189b850a4d3899ec6b31438faece31
-  data.tar.gz: 49ea1a19cc344523a9e5a38d356d59a20b99dbbc
+SHA256:
+  metadata.gz: 754426568e2bd5d5ca12e2aa4eaf352f58ad320f74cfe521c1be6afb40812fa6
+  data.tar.gz: ae661ea430059426eae209d78ebcb01defb1cb51d454825b6858569da2257fed
 SHA512:
-  metadata.gz: '07129a7dd8e2d3da9e8c321a486effe639f2670fc2f2431115892dd6e5c9ccc4aaefb202a43f98847605aea7f481b7b13130934d0173ae268ea146dde08cad78'
-  data.tar.gz: f22eac2aab0616901b5188e8a454eb96e419c9452b5752dd5aad1d08e305779ffff55e85bd202840260d4f822300d6da11e45369f525dcbf06d1222163653b7b
+  metadata.gz: 3d332dce7214607e2736506a75826fa6e6a7b8d68cfbc26d460706a786d011fce66ba747fbb28c5f012dbdf6b1dd5495814973b95817cda20c4649f13188242c
+  data.tar.gz: 3f41b2b35b1ff4c06452edb11a299e34c7e1698421c5e492821eafdfb67cd2da838d6139e1ca5d4cda34161b634b164726c22e2b0d7906ed05868ff83a59fe18

data/.appveyor.yml

@@ -5,6 +5,7 @@ environment:
   matrix:
     - RUBY_VERSION: 24
     - RUBY_VERSION: 24-x64
+    - RUBY_VERSION: 25-x64
 
 cache:
   - vendor/bundle

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+require: rubocop-rspec
+
+Metrics/LineLength:
+  Max: 100
+
+Style/BlockComments:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+Layout/EndOfLine:
+  EnforcedStyle: lf # enforce LF line endings on all platforms
+
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining

data/.travis.yml

@@ -0,0 +1,20 @@
+conditions: v1
+
+if: type = pull_request OR tag IS present
+
+os:
+  - linux
+  - osx
+
+language: ruby
+
+rvm:
+  - '2.3'
+  - '2.4'
+  - '2.5'
+
+install:
+  - bundle install --path vendor/bundle
+
+script:
+  - bundle exec rake

data/README.md

@@ -1,7 +1,11 @@
-# clocale
+# clocale [![travis-badge][]][travis] [![appveyor-badge][]][appveyor] [![codecov-badge][]][codecov]
 
-[![Build 
-status](https://ci.appveyor.com/api/projects/status/l7pp3mjqvocb2n9r/branch/master?svg=true)](https://ci.appveyor.com/project/avdv/clocale/branch/master)
+[travis]:         https://travis-ci.org/avdv/clocale
+[travis-badge]:   https://travis-ci.org/avdv/clocale.svg?branch=master
+[appveyor]:       https://ci.appveyor.com/project/avdv/clocale/branch/master
+[appveyor-badge]: https://ci.appveyor.com/api/projects/status/l7pp3mjqvocb2n9r/branch/master?svg=true
+[codecov]:        https://codecov.io/gh/avdv/clocale
+[codecov-badge]:  https://codecov.io/gh/avdv/clocale/branch/master/graph/badge.svg
 
 This Ruby extension provides access to the C library's `setlocale`, `strxfrm`
 and `strcoll` functions which are inherently useful for proper sorting

data/Rakefile

@@ -3,6 +3,14 @@ require 'rubygems/tasks'
 
 Gem::Tasks.new
 
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.ruby_opts = '-w'
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
 Rake::ExtensionTask.new 'clocale' do |ext|
   ext.lib_dir = 'lib/clocale'
 end
@@ -13,4 +21,5 @@ task test: %w[compile] do
   ruby '-Ilib', '-rclocale', '-e', 'p CLocale.setlocale(CLocale::LC_ALL, "")'
 end
 
-task default: :test
+task spec: :compile
+task default: %i[spec rubocop]

data/clocale.gemspec

@@ -1,19 +1,23 @@
 Gem::Specification.new do |spec|
   spec.name          = 'clocale'
-  spec.version       = '0.0.3'
+  spec.version       = '0.0.4'
   spec.authors       = ['Claudio Bley']
   spec.email         = ['claudio.bley@gmail.com']
-  spec.summary       = "A Ruby gem that wraps C locale functions."
+  spec.summary       = 'A Ruby gem that wraps C locale functions.'
   spec.homepage      = 'https://github.com/avdv/clocale'
   spec.license       = 'MIT'
 
   spec.extensions = %w[ext/clocale/extconf.rb]
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^.gitignore})
+    f.match(/^.gitignore/)
   end
 
+  spec.add_development_dependency 'codecov', '~> 0.1.10'
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rake-compiler', '~> 1.0'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rubocop', '~> 0.58'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.27'
   spec.add_development_dependency 'rubygems-tasks', '~> 0.2'
 end

data/ext/clocale/clocale.c

@@ -2,6 +2,25 @@
 #include <locale.h>
 #include <string.h>
 
+/*
+ * Changes or queries the locale for a specific category.
+ *
+ * @param category [Integer]     one of the constants defined in the CLocale module
+ * @param locale   [String, nil] Possible values for `locale`:
+ *
+ *    <tt>nil</tt>::  query the current setting, does not change the programs locale
+ *
+ *    <tt>""</tt>::   specifies an implementation defined native environment
+ *
+ *    <tt>"C"</tt>::  specifies a minimal "portable" locale
+ *
+ * @return [String] the value associated with the category
+ *
+ * @raise [RuntimeError] if setting the locale fails
+ *
+ * Calls the <tt>setlocale()</tt> C library function, see
+ * http://pubs.opengroup.org/onlinepubs/009695399/functions/setlocale.html.
+ */
 static VALUE
 lc_setlocale(VALUE self, VALUE category, VALUE locale) {
   const char* loc = NULL;
@@ -13,12 +32,29 @@ lc_setlocale(VALUE self, VALUE category, VALUE locale) {
   char* ret = setlocale(cat, loc);
 
   if (ret == NULL) {
-    rb_raise(rb_eRuntimeError, "error calling setlocale(%d, \"%s\")", cat, loc);
+    VALUE sym = rb_funcall(self, rb_intern("lookup_const"), 1, category);
+
+    if (NIL_P(sym)) {
+      rb_raise(rb_eRuntimeError, "error calling `setlocale(%d, \"%s\")`", cat, loc);
+    } else {
+      rb_raise(rb_eRuntimeError, "error calling `setlocale(%" PRIsVALUE ", \"%s\")`", sym, loc);
+    }
   } else {
     return rb_str_new2(ret);
   }
 }
 
+/*
+ * Compares two Strings using the current locale.
+ *
+ * @param s1 [String]
+ * @param s2 [String]
+ *
+ * @return [Integer] -1, 0, +1 if s1 is less than, equal to, or greater than s2 respectively
+ *
+ * Calls the <tt>strcoll()</tt> C library function, see
+ * http://pubs.opengroup.org/onlinepubs/009695399/functions/strcoll.html.
+ */
 static VALUE
 lc_strcoll(VALUE self, VALUE s1, VALUE s2) {
   int ret = strcoll(StringValueCStr(s1), StringValueCStr(s2));
@@ -30,6 +66,19 @@ lc_strcoll(VALUE self, VALUE s1, VALUE s2) {
   return INT2FIX(ret);
 }
 
+/*
+ * Transform the given String into a canonical form for char comparison.
+ *
+ * This is useful for sorting a list using Enumerable#sort_by which does a
+ * Schwartzian transform.
+ *
+ * @param s [String]
+ *
+ * @return [String] transformed according to the current <tt>LC_COLLATE</tt> locale setting
+ *
+ * Calls the <tt>strxfrm</tt> C library function, see
+ * http://pubs.opengroup.org/onlinepubs/009695399/functions/strxfrm.html.
+ */
 static VALUE
 lc_strxfrm(VALUE self, VALUE str) {
   VALUE ret;
@@ -50,7 +99,7 @@ lc_strxfrm(VALUE self, VALUE str) {
       size = needed + 1;
       buf = realloc(buf, size);
 
-      if (buf == NULL) rb_raise(rb_eNoMemError, "could not allocate %u bytes", size);
+      if (buf == NULL) rb_raise(rb_eNoMemError, "could not allocate %zu bytes", size);
     }
   }
 

data/ext/clocale/extconf.rb

@@ -2,7 +2,7 @@ require 'mkmf'
 
 def check_functions
   %w[setlocale strcoll strxfrm].each do |func|
-    abort "missing function `#{ func }``" unless have_func func
+    abort "missing function `#{func}``" unless have_func func
   end
 end
 

data/lib/clocale.rb

@@ -1,2 +1,15 @@
+# This module defines the `LC_*` constants and locale functions from the linked
+# C library of the current Ruby interpreter.
+#
+# @author Claudio Bley <claudio.bley@gmail.com>
+module CLocale
+  # Looks up the constant corresponding to the given integer value.
+  #
+  # @param int [Integer]
+  # @return [Symbol,nil] the <tt>LC_*</tt> constant as Symbol if found, nil otherwise
+  def self.lookup_const(int)
+    CLocale.constants.find { |s| CLocale.const_get(s) == int }
+  end
+end
 
 require 'clocale/clocale'

data/spec/c_locale_spec.rb

@@ -0,0 +1,29 @@
+require 'clocale'
+
+RSpec.describe CLocale do
+  %i[LC_ALL LC_COLLATE LC_CTYPE LC_MONETARY LC_NUMERIC LC_TIME].each do |const|
+    it "has #{const} constant" do
+      is_expected.to(satisfy { |m| m.const_defined? const })
+    end
+  end
+
+  describe 'lookup' do
+    described_class.constants.each do |const|
+      it "returns corresponding symbol for #{const}" do
+        int = described_class.const_get const
+
+        expect(described_class.lookup_const(int)).to eq(const)
+      end
+    end
+  end
+
+  it 'can call setlocale' do
+    expect { described_class.setlocale(CLocale::LC_ALL, '') }.not_to raise_error
+  end
+
+  it 'raises an error with invalid locales' do
+    expect {
+      described_class.setlocale(CLocale::LC_COLLATE, 'FOOBAR')
+    }.to raise_error(RuntimeError, /LC_COLLATE/)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,108 @@
+require 'simplecov'
+SimpleCov.start
+
+if ENV['CI']
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: clocale
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Claudio Bley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2018-08-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.27'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.27'
 - !ruby/object:Gem::Dependency
   name: rubygems-tasks
   requirement: !ruby/object:Gem::Requirement
@@ -61,6 +117,9 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".appveyor.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -69,6 +128,8 @@ files:
 - ext/clocale/clocale.c
 - ext/clocale/extconf.rb
 - lib/clocale.rb
+- spec/c_locale_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/avdv/clocale
 licenses:
 - MIT
@@ -89,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A Ruby gem that wraps C locale functions.