chars 0.2.1 → 0.2.2

data/.document

@@ -1,4 +1,4 @@
 lib/**/*.rb
 - 
-ChangeLog.*
+ChangeLog.md
 LICENSE.txt

data/.gitignore

@@ -0,0 +1,7 @@
+doc
+pkg
+tmp/*
+.DS_Store
+.yardoc
+*.swp
+*~

data/.yardopts

@@ -1 +1 @@
---markup markdown --title 'Chars Documentation' --protected --quiet --files ChangeLog.md,LICENSE.txt
+--markup markdown --title 'Chars Documentation' --protected --quiet

data/ChangeLog.md

@@ -1,3 +1,13 @@
+### 0.2.2 / 2012-05-28
+
+* {Chars::CharSet#initialize} now raises a TypeError when given arguments
+  that were neither a `String`, `Integer` or `Enumerable`.
+* Allow {Chars::CharSet#strings_in} to yield results as they are found.
+* Improved the performance of {Chars::CharSet#strings_in} when operating on
+  small Strings.
+* Replaced ore-tasks with
+  [rubygems-tasks](https://github.com/postmodern/rubygems-tasks#readme).
+
 ### 0.2.1 / 2011-06-22
 
 * Added {Chars::CharSet.[]}

data/LICENSE.txt

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2009-2010 Hal Brodigan
+Copyright (c) 2009-2012 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,8 +1,9 @@
 # Chars
 
-* http://chars.rubyforge.org/
-* http://github.com/postmodern/chars/
-* Postmodern (postmodern.mod3 at gmail.com)
+* [Source](https://github.com/postmodern/chars#readme)
+* [Issues](https://github.com/postmodern/chars/issues)
+* [Documentation](http://rubydoc.info/gems/chars)
+* [Email](mailto:postmodern.mod3 at gmail.com)
 
 ## Description
 

data/Rakefile

@@ -2,13 +2,13 @@ require 'rubygems'
 require 'rake'
 
 begin
-  gem 'ore-tasks', '~> 0.4'
-  require 'ore/tasks'
+  gem 'rubygems-tasks', '~> 0.1'
+  require 'rubygems/tasks'
 
-  Ore::Tasks.new
+  Gem::Tasks.new
 rescue LoadError => e
-  STDERR.puts e.message
-  STDERR.puts "Run `gem install ore-tasks` to install 'ore/tasks'."
+  warn e.message
+  warn "Run `gem install rubygems-tasks` to install 'rubygems/tasks'."
 end
 
 begin
@@ -25,7 +25,7 @@ task :test => :spec
 task :default => :spec
 
 begin
-  gem 'yard', '~> 0.6.0'
+  gem 'yard', '~> 0.7'
   require 'yard'
 
   YARD::Rake::YardocTask.new  

data/benchmarks/compare.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+
+require 'chars'
+require 'benchmark'
+
+CHARSET = Chars::ALPHA_NUMERIC
+N       = 1_000_000
+STRING  = ('A' * N) + '!'
+ENUM    = (['A', 0x42] * (N / 2)) << '!'
+
+Benchmark.bm(12) do |b|
+  b.report('String')     { CHARSET === STRING }
+  b.report('Enumerable') { CHARSET === ENUM }
+end

data/benchmarks/strings_in.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+
+require 'chars'
+require 'benchmark'
+
+CHARSET = Chars::ALPHA_NUMERIC
+STRING  = File.open('/usr/bin/openssl','rb') do |file|
+            file.read
+          end
+
+Benchmark.bm(24) do |b|
+  b.report('strings_in') do
+    CHARSET.strings_in(STRING) { |offset,string| }
+  end
+
+  (5..20).step(5) do |n|
+    b.report("strings_in (length=#{n})") do
+      CHARSET.strings_in(STRING, :length => n) { |offset,string| }
+    end
+  end
+end

data/chars.gemspec

@@ -2,126 +2,59 @@
 
 require 'yaml'
 
-Gem::Specification.new do |gemspec|
-  files = if File.directory?('.git')
-            `git ls-files`.split($/)
-          elsif File.directory?('.hg')
-            `hg manifest`.split($/)
-          elsif File.directory?('.svn')
-            `svn ls -R`.split($/).select { |path| File.file?(path) }
-          else
-            Dir['{**/}{.*,*}'].select { |path| File.file?(path) }
-          end
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
 
-  filter_files = lambda { |paths|
-    case paths
-    when Array
-      (files & paths)
-    when String
-      (files & Dir[paths])
-    end
-  }
-
-  version = {
-    :file => 'lib/chars/version.rb',
-    :constant => 'Chars::VERSION'
-  }
-
-  defaults = {
-    'name' => File.basename(File.dirname(__FILE__)),
-    'files' => files,
-    'executables' => filter_files['bin/*'].map { |path| File.basename(path) },
-    'test_files' => filter_files['{test/{**/}*_test.rb,spec/{**/}*_spec.rb}'],
-    'extra_doc_files' => filter_files['*.{txt,rdoc,md,markdown,tt,textile}'],
-  }
-
-  metadata = defaults.merge(YAML.load_file('gemspec.yml'))
-
-  gemspec.name = metadata.fetch('name',defaults[:name])
-  gemspec.version = if metadata['version']
-                      metadata['version']
-                    elsif File.file?(version[:file])
-                      require File.join('.',version[:file])
-                      eval(version[:constant])
-                    end
-
-  gemspec.summary = metadata.fetch('summary',metadata['description'])
-  gemspec.description = metadata.fetch('description',metadata['summary'])
-
-  case metadata['license']
-  when Array
-    gemspec.licenses = metadata['license']
-  when String
-    gemspec.license = metadata['license']
-  end
-
-  case metadata['authors']
-  when Array
-    gemspec.authors = metadata['authors']
-  when String
-    gemspec.author = metadata['authors']
-  end
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
 
-  gemspec.email = metadata['email']
-  gemspec.homepage = metadata['homepage']
+                  require 'chars/version'
+                  Chars::VERSION
+                end
 
-  case metadata['require_paths']
-  when Array
-    gemspec.require_paths = metadata['require_paths']
-  when String
-    gemspec.require_path = metadata['require_paths']
-  end
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
 
-  gemspec.files = filter_files[metadata['files']]
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
 
-  gemspec.executables = metadata['executables']
-  gemspec.extensions = metadata['extensions']
+  gem.files = `git ls-files`.split($/)
+  gem.files = glob[gemspec['files']] if gemspec['files']
 
-  if Gem::VERSION < '1.7.'
-    gemspec.default_executable = gemspec.executables.first
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
   end
+  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
 
-  gemspec.test_files = filter_files[metadata['test_files']]
-
-  unless gemspec.files.include?('.document')
-    gemspec.extra_rdoc_files = metadata['extra_doc_files']
-  end
-
-  gemspec.post_install_message = metadata['post_install_message']
-  gemspec.requirements = metadata['requirements']
-
-  if gemspec.respond_to?(:required_ruby_version=)
-    gemspec.required_ruby_version = metadata['required_ruby_version']
-  end
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.test_files       = glob[gemspec['test_files'] || '{test/{**/}*_test.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
 
-  if gemspec.respond_to?(:required_rubygems_version=)
-    gemspec.required_rubygems_version = metadata['required_ruby_version']
-  end
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
 
-  parse_versions = lambda { |versions|
-    case versions
-    when Array
-      versions.map { |v| v.to_s }
-    when String
-      versions.split(/,\s*/)
-    end
-  }
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
 
-  if metadata['dependencies']
-    metadata['dependencies'].each do |name,versions|
-      gemspec.add_dependency(name,parse_versions[versions])  
-    end
-  end
+  split = lambda { |string| string.split(/,\s*/) }
 
-  if metadata['runtime_dependencies']
-    metadata['runtime_dependencies'].each do |name,versions|
-      gemspec.add_runtime_dependency(name,parse_versions[versions])  
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
     end
   end
 
-  if metadata['development_dependencies']
-    metadata['development_dependencies'].each do |name,versions|
-      gemspec.add_development_dependency(name,parse_versions[versions])  
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
     end
   end
 end

data/gemspec.yml

@@ -5,7 +5,7 @@ description:
   recognizing text and generating random text from specific character sets.
 
 license: MIT
-homepage: http://github.com/postmodern/chars
+homepage: https://github.com/postmodern/chars#readme
 authors: Postmodern
 email: postmodern.mod3@gmail.com
 has_yard: true
@@ -13,6 +13,6 @@ has_yard: true
 required_ruby_version: ">= 1.8.7"
 
 development_dependencies:
-  ore-tasks: ~> 0.4
+  rubygems-tasks: ~> 0.1
   rspec: ~> 2.4
-  yard: ~> 0.6.1
+  yard: ~> 0.7

data/lib/chars/char_set.rb

@@ -9,6 +9,9 @@ module Chars
     # @param [Array<String, Integer, Enumerable>] arguments
     #   The chars for the CharSet.
     #
+    # @raise [TypeError]
+    #   One of the arguments was not a {String}, {Integer} or `Enumerable`.
+    #
     def initialize(*arguments)
       super()
 
@@ -21,7 +24,7 @@ module Chars
         when Enumerable
           subset.each { |char| self << char }
         else
-          raise(ArgumentError,"arguments must be a String, Integer or Enumerable")
+          raise(TypeError,"arguments must be a String, Integer or Enumerable")
         end
       end
     end
@@ -46,7 +49,7 @@ module Chars
     # @return [CharSet]
     #   The modified character set.
     #
-    # @raise [ArgumentError]
+    # @raise [TypeError]
     #   The argument was not a {String} or {Integer}.
     #
     # @since 0.2.1
@@ -65,7 +68,7 @@ module Chars
       when Integer
         super(other)
       else
-        raise(ArgumentError,"can only append Strings and Integers")
+        raise(TypeError,"can only append Strings and Integers")
       end
     end
 
@@ -326,23 +329,36 @@ module Chars
     #   sub-strings within the data, or to just return the matched
     #   sub-strings themselves.
     #
-    def strings_in(data,options={})
-      min_length = options.fetch(:length,4)
-
-      return found if data.length < min_length
+    # @yield [match,(index)]
+    #   The given block will be passed every matched sub-string, and the
+    #   optional index.
+    #
+    # @yield [String] match
+    #   A sub-string containing the characters from the character set.
+    #
+    # @yield [Integer] index
+    #   The index the sub-string was found at.
+    #
+    # @return [Array, Hash]
+    #   If no block is given, an Array or Hash of sub-strings is returned.
+    #
+    def strings_in(data,options={},&block)
+      unless block
+        if options[:offsets]
+          found = {}
+          block = lambda { |offset,substring| found[offset] = substring }
+        else
+          found = []
+          block = lambda { |substring| found << substring }
+        end
 
-      if options[:offsets]
-        found = {}
-        found_substring = lambda { |offset,substring|
-          found[offset] = substring
-        }
-      else
-        found = []
-        found_substring = lambda { |offset,substring|
-          found << substring
-        }
+        strings_in(data,options,&block)
+        return found
       end
 
+      min_length = options.fetch(:length,4)
+      return if data.length < min_length
+
       index = 0
 
       while index <= (data.length - min_length)
@@ -353,14 +369,20 @@ module Chars
             sub_index += 1
           end
 
-          found_substring.call(index,data[index...sub_index])
+          match = data[index...sub_index]
+
+          case block.arity
+          when 2
+            yield match, index
+          else
+            yield match
+          end
+
           index = sub_index
         else
           index += 1
         end
       end
-
-      return found
     end
 
     #
@@ -385,7 +407,7 @@ module Chars
     # Compares the bytes within a given string with the bytes of the
     # character set.
     #
-    # @param [String, Enumerable] string
+    # @param [String, Enumerable] other
     #   The string to compare with the character set.
     #
     # @return [Boolean]

data/lib/chars/version.rb

@@ -1,4 +1,4 @@
 module Chars
-  # Chars version
-  VERSION = '0.2.1'
+  # chars version
+  VERSION = '0.2.2'
 end

metadata

@@ -1,70 +1,85 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: chars
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.2
   prerelease: 
-  version: 0.2.1
 platform: ruby
-authors: 
+authors:
 - Postmodern
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-22 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: ore-tasks
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2012-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.4"
+      - !ruby/object:Gem::Version
+        version: '0.1'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.4"
+      - !ruby/object:Gem::Version
+        version: '2.4'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.6.1
+      - !ruby/object:Gem::Version
+        version: '0.7'
   type: :development
-  version_requirements: *id003
-description: Chars is a Ruby library for working with various character sets, recognizing text and generating random text from specific character sets.
-email: 
-- postmodern.mod3@gmail.com
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Chars is a Ruby library for working with various character sets, recognizing
+  text and generating random text from specific character sets.
+email: postmodern.mod3@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.md
+extra_rdoc_files:
 - ChangeLog.md
 - LICENSE.txt
-files: 
+- README.md
+files:
 - .document
 - .gemspec
+- .gitignore
 - .rspec
 - .yardopts
 - ChangeLog.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmarks/compare.rb
+- benchmarks/strings_in.rb
 - chars.gemspec
 - gemspec.yml
 - lib/chars.rb
@@ -79,35 +94,29 @@ files:
 - spec/extensions/integer_spec.rb
 - spec/extensions/string_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/postmodern/chars
-licenses: 
+homepage: https://github.com/postmodern/chars#readme
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: chars
-rubygems_version: 1.8.5
+rubyforge_project: 
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A Ruby library for working with various character sets
-test_files: 
-- spec/chars_spec.rb
-- spec/char_set_spec.rb
-- spec/extensions/integer_spec.rb
-- spec/extensions/string_spec.rb
+test_files: []