ruby-magic 0.2.0 → 0.3.0

data/lib/magic/version.rb

@@ -1,76 +1,42 @@
-# -*- encoding: utf-8 -*-
-
-# :stopdoc:
-
-#
-# version.rb
-#
-# Copyright 2013-2015 Krzysztof Wilczynski
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-# :startdoc:
+# frozen_string_literal: true
 
 class Magic
   #
   # Current version of _Magic_.
   #
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 
   class << self
     #
     # call-seq:
-    #    Magic.version_to_a -> array
-    #
-    # Returns
+    #    Magic.version_array -> array
     #
     # Example:
     #
-    #    Magic.version_to_a   #=> [5, 17]
-    #
-    # Will raise <i>Magic::NotImplementedError</i> exception if, or
+    #    Magic.version_array #=> [5, 39]
     #
-    # See also: Magic::version_to_s
+    # See also: Magic::version and Magic::version_string
     #
-    def version_to_a
+    def version_array
       [self.version / 100, self.version % 100]
     end
 
+    alias_method :version_to_a, :version_array
+
     #
     # call-seq:
-    #    Magic.version_to_s -> string
-    #
-    # Returns
+    #    Magic.version_string -> string
     #
     # Example:
     #
-    #    Magic.version_to_s   #=> "5.17"
-    #
-    # Will raise <i>Magic::NotImplementedError</i> exception if, or
+    #    Magic.version_string #=> "5.39"
     #
-    # See also: Magic::version_to_a
+    # See also: Magic::version and Magic::version_array
     #
-    def version_to_s
-      '%d.%02d' % self.version_to_a
+    def version_string
+      '%d.%02d' % self.version_array
     end
 
-    alias_method :version_array,  :version_to_a
-    alias_method :version_string, :version_to_s
+    alias_method :version_to_s, :version_string
   end
 end
-
-# :enddoc:
-
-# vim: set ts=2 sw=2 sts=2 et :
-# encoding: utf-8

metadata

@@ -1,56 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: ruby-magic
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
-- Krzysztof Wilczynski
+- Krzysztof Wilczyński
 autorequire: 
 bindir: bin
-cert_chain: []
-date: 2015-03-26 00:00:00.000000000 Z
+cert_chain:
+- kwilczynski-public.pem
+date: 2021-03-25 00:00:00.000000000 Z
 dependencies: []
 description: |
   File Magic in Ruby.
 
   Simple interface to libmagic for Ruby Programming Language.
-email: krzysztof.wilczynski@linux.com
-executables:
-- magic
+email: kw@linux.com
+executables: []
 extensions:
 - ext/magic/extconf.rb
 extra_rdoc_files: []
 files:
 - AUTHORS
-- CHANGES
-- CHANGES.rdoc
+- CHANGELOG.md
 - COPYRIGHT
 - LICENSE
-- README
-- README.rdoc
-- Rakefile
-- TODO
+- NOTICE
+- README.md
 - VERSION
-- bin/magic
 - ext/magic/common.h
 - ext/magic/extconf.rb
 - ext/magic/functions.c
 - ext/magic/functions.h
 - ext/magic/ruby-magic.c
 - ext/magic/ruby-magic.h
+- kwilczynski-public.pem
 - lib/magic.rb
 - lib/magic/core/file.rb
 - lib/magic/core/string.rb
 - lib/magic/version.rb
-- ruby-magic.gemspec
-- test/helpers/magic_test_helper.rb
-- test/test_constants.rb
-- test/test_magic.rb
-homepage: http://about.me/kwilczynski
+homepage: https://github.com/kwilczynski/ruby-magic
 licenses:
-- Apache License, Version 2.0
-metadata: {}
-post_install_message: 
+- Apache-2.0
+metadata:
+  bug_tracker_uri: https://github.com/kwilczynski/ruby-magic/issues
+  source_code_uri: https://github.com/kwilczynski/ruby-magic
+  changelog_uri: https://github.com/kwilczynski/ruby-magic/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/ruby-magic
+  wiki_uri: https://github.com/kwilczynski/ruby-magic/wiki
+post_install_message: 'Thank you for installing!
+
+'
 rdoc_options: []
 require_paths:
 - lib
@@ -59,15 +59,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: File Magic in Ruby

data/CHANGES

@@ -1,50 +0,0 @@
-ruby-magic (0.2.0)
-
-  * Fixed formatting and white spaces.
-  * Added Gemnasium, plus Coveralls and Code Climate integration (and hence improved
-    code test coverage).
-  * Fixed Travis CI build against Rubinius.
-  * Re-factored the API and cleaned up small portions of code and documentation.
-  * Retired support for Ruby 1.8.x (no support for MRI, Ruby Enterprise Edition and Rubinius).
-  * Added functionality to handle releasing the GVL for any file and/or I/O operations.
-  * Added ability to Magic#flags_array to return name of each flag that is set.
-  * Changed Magic#version_array and Magic#version_string methods to be a singleton methods.
-  * Renamed the Magic#flags_array method to Magic#flags_to_a.
-  * Retired testing with Ruby 1.9.2 and 2.1.0, and added 2.2.0 on Travis CI.
-  * Added naïve synchronization via Mutex#lock and Mutex#unlock methods to make interactions
-    with libmagic more thread-safe.
-  * Changed the Magic::new method, so that it accepts an array of paths from which to load
-    the Magic database.
-  * Fixed setting of global errno value to avoid race conditions.
-  * Added ability for Travis CI test against multiple versions of vanilla libmagic.
-  * Added LLVM (clang) compiler to build with to Travis CI, and fixed various issues reported
-    by clang compiler during build-time.
-  * Added ability for Magic#load to take nil as valid argument.
-  * Fixed issue with libmagic's regular expression (regex) library not working with UTF-8 (or
-    any other wide-character encoding).
-  * Fixed build to make it work with C++ compilers.
-  * Added support for the MAGIC_CONTINUE flag so that Magic#file, Magic#buffer and
-    Magic#descriptor methods will return an array for multiple results when appropriate.
-  * Moved integration with File and String core classes into separate namespace.
-  * Removed forward declaration of errno as it's not needed on systems with modern C/C++
-    libraries and compilers.
-  * Added rudimentary Vagrantfile that can be used to build a development environment.
-  * Removed the "-Wl,--no-undefined" option from LDFLAGS, as they might break on some systems.
-  * Fixed any C90 standard related build-time warnings.
-  * Changed the behaviour not to catch the generic Magic::Error, plus always to raise on errors
-    coming from libmagic. This is to make it more aligned with the standard library, where file
-    and I/O related errors would raise an appropriate exception.
-  * Fixed version number to comply with Semantic Versioning 2 (http://semver.org/).
-  * Added the Guard Ruby gem for convenience, with an appropriate Guardfile.
-  * Changed behaviour consistent among various versions of libmagic adhering to the POSIX
-    standard. This concerns the following IEEE 1003.1 standards:
-    - http://pubs.opengroup.org/onlinepubs/007904975/utilities/file.html
-    - http://pubs.opengroup.org/onlinepubs/9699919799/utilities/file.html
-
--- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Wed, 25 Mar 2015 23:27:00 +0000
-
-ruby-magic (0.0.1)
-
-  * First version.
-
--- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Fri, 21 Mar 2014 16:49:26 +0000

data/CHANGES.rdoc

@@ -1,50 +0,0 @@
-ruby-magic (0.2.0)
-
-  * Fixed formatting and white spaces.
-  * Added Gemnasium, plus Coveralls and Code Climate integration (and hence improved
-    code test coverage).
-  * Fixed Travis CI build against Rubinius.
-  * Re-factored the API and cleaned up small portions of code and documentation.
-  * Retired support for Ruby 1.8.x (no support for MRI, Ruby Enterprise Edition and Rubinius).
-  * Added functionality to handle releasing the GVL for any file and/or I/O operations.
-  * Added ability to Magic#flags_array to return name of each flag that is set.
-  * Changed Magic#version_array and Magic#version_string methods to be a singleton methods.
-  * Renamed the Magic#flags_array method to Magic#flags_to_a.
-  * Retired testing with Ruby 1.9.2 and 2.1.0, and added 2.2.0 on Travis CI.
-  * Added naïve synchronization via Mutex#lock and Mutex#unlock methods to make interactions
-    with libmagic more thread-safe.
-  * Changed the Magic::new method, so that it accepts an array of paths from which to load
-    the Magic database.
-  * Fixed setting of global errno value to avoid race conditions.
-  * Added ability for Travis CI test against multiple versions of vanilla libmagic.
-  * Added LLVM (clang) compiler to build with to Travis CI, and fixed various issues reported
-    by clang compiler during build-time.
-  * Added ability for Magic#load to take nil as valid argument.
-  * Fixed issue with libmagic's regular expression (regex) library not working with UTF-8 (or
-    any other wide-character encoding).
-  * Fixed build to make it work with C++ compilers.
-  * Added support for the MAGIC_CONTINUE flag so that Magic#file, Magic#buffer and
-    Magic#descriptor methods will return an array for multiple results when appropriate.
-  * Moved integration with File and String core classes into separate namespace.
-  * Removed forward declaration of errno as it's not needed on systems with modern C/C++
-    libraries and compilers.
-  * Added rudimentary Vagrantfile that can be used to build a development environment.
-  * Removed the "-Wl,--no-undefined" option from LDFLAGS, as they might break on some systems.
-  * Fixed any C90 standard related build-time warnings.
-  * Changed the behaviour not to catch the generic Magic::Error, plus always to raise on errors
-    coming from libmagic. This is to make it more aligned with the standard library, where file
-    and I/O related errors would raise an appropriate exception.
-  * Fixed version number to comply with Semantic Versioning 2 (http://semver.org/).
-  * Added the Guard Ruby gem for convenience, with an appropriate Guardfile.
-  * Changed behaviour consistent among various versions of libmagic adhering to the POSIX
-    standard. This concerns the following IEEE 1003.1 standards:
-    - http://pubs.opengroup.org/onlinepubs/007904975/utilities/file.html
-    - http://pubs.opengroup.org/onlinepubs/9699919799/utilities/file.html
-
--- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Wed, 25 Mar 2015 23:27:00 +0000
-
-ruby-magic (0.0.1)
-
-  * First version.
-
--- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Fri, 21 Mar 2014 16:49:26 +0000

data/README

@@ -1 +0,0 @@
-Simple interface to libmagic for Ruby Programming Language

data/README.rdoc

@@ -1,8 +0,0 @@
-Simple interface to libmagic for Ruby Programming Language
-
-{<img src="https://travis-ci.org/kwilczynski/ruby-magic.png?branch=master" alt="Build Status"/>}[https://travis-ci.org/kwilczynski/ruby-magic]
-{<img src="http://inch-ci.org/github/kwilczynski/ruby-magic.svg?branch=master" alt="Documentation Status" />}[http://inch-ci.org/github/kwilczynski/ruby-magic]
-{<img src="https://badge.fury.io/rb/ruby-magic.png" alt="Gem Version" />}[http://badge.fury.io/rb/ruby-magic]
-{<img src="https://coveralls.io/repos/kwilczynski/ruby-magic/badge.png?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/kwilczynski/ruby-magic?branch=master]
-{<img src="https://codeclimate.com/github/kwilczynski/ruby-magic.png" alt="Code Quality" />}[https://codeclimate.com/github/kwilczynski/ruby-magic]
-{<img src="https://gemnasium.com/kwilczynski/ruby-magic.png" alt="Dependency Status" />}[https://gemnasium.com/kwilczynski/ruby-magic]

data/Rakefile

@@ -1,79 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-# :enddoc:
-
-#
-# Rakefile
-#
-# Copyright 2013-2015 Krzysztof Wilczynski
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-gem 'rdoc', '>= 4.1.1'
-
-begin
-  require 'rake'
-  require 'rdoc/task'
-  require 'rake/testtask'
-  require 'rake/extensiontask'
-rescue LoadError
-  require 'rubygems'
-  require 'rake'
-  require 'rdoc/task'
-  require 'rake/testtask'
-  require 'rake/extensiontask'
-end
-
-CLEAN.include   '*{.h,.o,.log,.so}', 'ext/**/*{.o,.log,.so}', 'Makefile', 'ext/**/Makefile'
-CLOBBER.include 'lib/**/*.so', 'doc/**/*'
-
-gem = eval File.read('ruby-magic.gemspec')
-
-RDoc::Task.new do |d|
-  files = %w(AUTHORS CHANGES.rdoc COPYRIGHT LICENSE README.rdoc TODO)
-
-  d.title = 'File Magic in Ruby'
-  d.main  = 'README.rdoc'
-
-  d.rdoc_dir = 'doc/rdoc'
-
-  d.rdoc_files.include 'ext/**/*.{c,h}', 'lib/**/*.rb'
-  d.rdoc_files.include.add(files)
-
-  d.options << '--line-numbers'
-end
-
-Rake::TestTask.new do |t|
-  t.verbose    = true
-  t.warning    = true
-  t.test_files = Dir['test/**/test_*']
-end
-
-Gem::PackageTask.new(gem) do |p|
-  p.need_zip = true
-  p.need_tar = true
-end
-
-Rake::ExtensionTask.new('magic', gem) do |e|
-  e.ext_dir = 'ext/magic'
-  e.lib_dir = 'lib/magic'
-end
-
-Rake::Task[:test].prerequisites << :clobber
-Rake::Task[:test].prerequisites << :compile
-
-task :default => :test
-
-# vim: set ts=2 sw=2 sts=2 et :
-# encoding: utf-8

data/TODO

@@ -1,24 +0,0 @@
-ruby-magic (0.5.0)
-
-  * Vendor libmagic source code?
-
--- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Wed, 25 Mar 2015 23:27:00 +0000
-
-ruby-magic (0.4.0)
-
-  * Add some examples;
-  * Move to YARD from RDoc (as RDoc is very bad, really);
-  * Improve documentation i.e. source code commenting, README file, etc.
-
--- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Wed, 25 Mar 2015 23:27:00 +0000
-
-ruby-magic (0.3.0)
-
-  * Improve test coverage (if possible to 100%);
-  * Add implementation for the included "binary";
-  * Add Doxygen style comments for other functions in the source code;
-  * Add RDoc and improve documentation i.e. source code commenting;
-  * Add support for magic_load_buffers(magic_t, void **, size_t *, size_t);
-  * Add support for Windows (if possible).
-
--- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Wed, 25 Mar 2015 23:27:00 +0000

data/bin/magic

@@ -1,33 +0,0 @@
-#!/usr/bin/env ruby
-
-# -*- encoding: utf-8 -*-
-
-# :enddoc:
-
-#
-# magic
-#
-# Copyright 2013-2015 Krzysztof Wilczynski
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-begin
-  require 'magic'
-rescue LoadError
-  require 'rubygems'
-  require 'magic'
-end
-
-# vim: set ts=2 sw=2 sts=2 et :
-# encoding: utf-8

data/ruby-magic.gemspec

@@ -1,62 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-# :enddoc:
-
-#
-# ruby-magic.gemspec
-#
-# Copyright 2013-2015 Krzysztof Wilczynski
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-signing_key = File.expand_path('~/.gem/kwilczynski-private.pem')
-
-Gem::Specification.new do |s|
-  s.name    = 'ruby-magic'
-  s.summary = 'File Magic in Ruby'
-
-  s.description = <<-EOS
-File Magic in Ruby.
-
-Simple interface to libmagic for Ruby Programming Language.
-  EOS
-
-  s.platform = Gem::Platform::RUBY
-  s.version  = File.read('VERSION').strip
-  s.license  = 'Apache License, Version 2.0'
-  s.author   = 'Krzysztof Wilczynski'
-  s.email    = 'krzysztof.wilczynski@linux.com'
-  s.homepage = 'http://about.me/kwilczynski'
-  s.has_rdoc = true
-
-  s.required_ruby_version = '>= 1.9.2'
-  s.rubygems_version      = '~> 2.2.0'
-
-  s.files = Dir['ext/**/*.{c,h,rb}'] +
-            Dir['lib/**/*.rb']       +
-            Dir['benchmark/**/*.rb'] +
-            Dir['test/**/*.rb']      +
-            %w(Rakefile ruby-magic.gemspec AUTHORS
-               CHANGES CHANGES.rdoc COPYRIGHT LICENSE
-               README README.rdoc TODO VERSION)
-
-  s.executables   << 'magic'
-  s.require_paths << 'lib'
-  s.extensions    << 'ext/magic/extconf.rb'
-
-  s.signing_key = signing_key if File.exists?(signing_key)
-end
-
-# vim: set ts=2 sw=2 sts=2 et :
-# encoding: utf-8