enco 0.1.0 → 0.1.1

data/.gitignore

@@ -2,12 +2,21 @@
 .bundle
 Gemfile.lock
 pkg/*
-.idea/
+.idea/*
 doc/
-log/*.log
-/tmp/
-tmp/
+log/*
+tmp/*
 db/*.sqlite3
 /coverage
 /coverage.data
 /.yardoc
+.rvmrc
+
+## generic files to ignore
+*~
+*.lock
+*.DS_Store
+*.swp
+*.out
+*.swo
+*.md.html

data/HISTORY.md

@@ -1,3 +1,8 @@
+0.1.1
+=====
+Removed special cases for frozen string.
+Enco does not touch input string at all from now.
+
 0.1.0
 =====
 Main functionality implemented

data/LICENSE

@@ -1,7 +1,16 @@
 Copyright (c) 2011 Alexander N Paramonov
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ documentation files (the "Software"), to deal in the Software without restriction,
+ including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+ subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+ USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,6 +1,6 @@
 Enco
 ==========
-Enco will convert any string to utf-8
+Enco will convert any string to utf-8, based on original string encoding.
 
 Installation
 ------------
@@ -12,27 +12,26 @@ It is simple. Just call
 
     my_utf8_string = Enco.to_utf8 any_string
 
-It will return non string objects back:
+If you pass something other, than a string, it'll return non string objects back:
 
-    Enco.to_utf8(not_a_string) === not_a_string
+    Enco.to_utf8(not_a_string) === not_a_string # true
 
-works correctly with frozen strings. If you dont want to convert frozen string, pass :ignore_frozen => true and Enco
-will ignore that string:
+Enco does not touch input string, so you may pass frozen strings to it and it'll handle them correctly.
 
-    Enco.to_utf8 any_string.frozen, :ignore_frozen => true # returns frozen string
-    Enco.to_utf8 any_string.frozen                         # returns dup of any_string, converted to utf-8
+    frozen_string = "hi there!".frozen
+    Enco.to_utf8 frozen_string         # utf-8 analog of frozen_string
 
 ### Plugins
 Add
 
     require 'enco/string_to_utf8'
 
-end you'll get
+and you'll get #to_utf-8 method on String objects:
 
-    "any string".to_utf8
-method that accept same options as
+    "hi there!".to_utf8
+It delegates to Enco.to_utf8 and accepts same options as
 
-    Enco.to_utf8 "any string"
+    Enco.to_utf8 "hi there!"
 
 
 Requirements

data/enco.gemspec

@@ -22,5 +22,4 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec", ">= 2.6"
   s.add_development_dependency "rake"
   s.add_runtime_dependency "rchardet19"
-  #s.add_runtime_dependency "activesupport"
 end

data/lib/enco.rb

@@ -6,13 +6,9 @@ require 'rchardet19'
 module Enco
   # @param [String] string
   # @param [Hash] options
-  # @option options [Boolean] :ignore_frozen
-  def self.to_utf8 string, options = {}
+  def self.to_utf8(string, options = {})
     return string unless string.is_a? String
-    if string.frozen?
-      return string if true == options[:ignore_frozen]
-      string = string.dup
-    end
+    string = string.dup
 
     cd = ::CharDet.detect(string, :silent => true)
 

data/lib/enco/string_to_utf8.rb

@@ -1,6 +1,7 @@
 require "enco"
+
 class String
-  def to_utf8 *args
+  def to_utf8(*args)
     Enco.to_utf8 self, *args
   end
 end

data/lib/enco/version.rb

@@ -1,3 +1,3 @@
 module Enco
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/enco_spec.rb

@@ -3,12 +3,24 @@ require "spec_helper"
 
 # TODO add more Test cases
 describe Enco do
-  before(:each) do
-    @simple_string   = %Q{test string\nin }
-    @cyrillic_string = %Q{тестовая строка\nin }
+  it "should not touch input string" do
+    test_string = "test string".force_encoding "ISO-8859-15"
+    saved  = test_string
+    result = Enco.to_utf8 test_string
+
+    test_string.encoding.to_s.should == "ISO-8859-15"
+    result.encoding.to_s.should == "UTF-8"
+
+    test_string.should === saved
   end
+
   describe "#to_utf8" do
     describe "argument is" do
+      before(:each) do
+        @simple_string   = %Q{test string\nin }
+        @cyrillic_string = %Q{тестовая строка\nin }
+      end
+      
       context "a string in" do
         specify "UTF-8 encoding" do
           result = Enco.to_utf8(string_in 'UTF-8')
@@ -44,26 +56,13 @@ describe Enco do
       context "a frozen string" do
         before(:each) do
           @test_string = "test string".force_encoding "ISO-8859-15"
+          @test_string.freeze
         end
 
         it "should perform conversion" do
-          result = Enco.to_utf8 @test_string.freeze
+          result = Enco.to_utf8 @test_string
           result.encoding.to_s.should == "UTF-8"
         end
-
-        it "should not change input string" do
-          Enco.to_utf8 @test_string.freeze
-
-          @test_string.encoding.to_s.should == "ISO-8859-15"
-        end
-
-        context "ignore_frozen flag set to true" do
-          it "should return string itself" do
-            result = Enco.to_utf8 @test_string.freeze, :ignore_frozen => true
-            result.should eq @test_string
-            result.encoding.to_s.should == "ISO-8859-15"
-          end
-        end
       end
 
       context "not a string" do
@@ -80,7 +79,6 @@ describe Enco do
           end
         end
       end
-
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enco
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-04 00:00:00.000000000 Z
+date: 2012-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &16372380 !ruby/object:Gem::Requirement
+  requirement: &6560080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *16372380
+  version_requirements: *6560080
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &16371400 !ruby/object:Gem::Requirement
+  requirement: &6559580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16371400
+  version_requirements: *6559580
 - !ruby/object:Gem::Dependency
   name: rchardet19
-  requirement: &16370800 !ruby/object:Gem::Requirement
+  requirement: &6583380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16370800
+  version_requirements: *6583380
 description: Enco will convert any string to utf-8.
 email:
 - alexander.n.paramonov@gmail.com
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: enco
-rubygems_version: 1.8.12
+rubygems_version: 1.8.13
 signing_key: 
 specification_version: 3
 summary: Nice utf8 converter