chupa-text 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5899941addcc8a58730a1d5ff4194d13f17f6504
-  data.tar.gz: b219d29ca910fd3a4951236f922e3bfe7211e6ef
+  metadata.gz: 7c546de1729dc7d16dc0cdb177e34831f2d8ad75
+  data.tar.gz: 1e09aa57e331286ba22396611cb00d95e33361a0
 SHA512:
-  metadata.gz: 8cc52887b919a6cbb4936c1c039eeb7161a239257558e01198083af19c0c4f950ee85adf21f7d3ee4dbbf0b0f06475a6484dc02633361ff9d27da33d75d2e82d
-  data.tar.gz: b342d42379f88c32e30a20d53008a557cca0f3e5f4ddfde75fe2aca4ad921c24bd4eef6fd0515203fec1d3f2cc71f93fc150e7bde5d43cf34055dd0da8b30d81
+  metadata.gz: 4f8f26b9d4616dcceec080628191aa5842881766f080ab91f939a5ab9aa3c8308f402d4a1df9059914ee421db635557dd925db5ea4b25a6b4319dc27983db4a7
+  data.tar.gz: 2e6052a5172b2c974311441099afdf2612641668ce003be79335081bf39caa54033de2b951d22d1bdefd3b7dcb1500db34421b60431856bea289fde039b2234c

data/doc/text/news.md

@@ -1,5 +1,13 @@
 # News
 
+## 1.0.3: 2014-02-17
+
+  * Added `ChupaText::EncryptedError`.
+  * Added `ChupaText::InvalidDataError`.
+  * Added `ChupaText::Attributes`.
+  * `ChupaText::Data#attributes` returns `ChupaText::Attributes` instead
+    of `Hash`.
+
 ## 1.0.2: 2014-02-15
 
   * Added `ChupaText::SizeParser`.

data/lib/chupa-text.rb

@@ -41,6 +41,7 @@ require "chupa-text/formatters"
 require "chupa-text/file-content"
 require "chupa-text/virtual-content"
 
+require "chupa-text/attributes"
 require "chupa-text/data"
 require "chupa-text/input-data"
 require "chupa-text/virtual-file-data"

data/lib/chupa-text/attributes.rb

@@ -0,0 +1,126 @@
+# Copyright (C) 2014  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+module ChupaText
+  # Attributes of data.
+  class Attributes < Struct.new(:title,
+                                :author,
+                                :encoding,
+                                :created_time,
+                                :modified_time)
+    include Enumerable
+
+    def initialize
+      super
+      @members = members
+      @extra_data = {}
+    end
+
+    def to_h
+      super.merge(@extra_data)
+    end
+
+    def inspect
+      super.gsub(/>\z/) do
+        " @extra_data=#{@extra_data.inspect}>"
+      end
+    end
+
+    # @yield [name, value] Gives attribute name and value to the block.
+    # @yieldparam [Symbol] name The attribute name.
+    # @yieldparam [Object] value The attribute value.
+    def each(&block)
+      if block.nil?
+        Enumerator.new(self, :each)
+      else
+        each_pair(&block)
+        @extra_data.each_pair(&block)
+      end
+    end
+
+    # Gets the value of attribute named `name`.
+    #
+    # @param [Symbol, String] name The attribute name.
+    # @return [Object] The attribute value.
+    def [](name)
+      name = normalize_name(name)
+      if @members.key?(name)
+        super
+      else
+        @extra_data[name]
+      end
+    end
+
+    # Sets `value` as the value of attribute named `name`.
+    #
+    # @param [Symbol, String] name The attribute name.
+    # @param [Object] value The attribute value.
+    def []=(name, value)
+      name = normalize_name(name)
+      if @members.key?(name)
+        send("#{name}=", value)
+      else
+        @extra_data[name] = value
+      end
+    end
+
+    # Sets `encoding` as the `encoding` attribute value.
+    #
+    # @param [String, Encoding, nil] encoding The encoding.
+    def encoding=(encoding)
+      super(normalize_encoding(encoding))
+    end
+
+    # Sets `time` as the `created_time` attribute value.
+    #
+    # @param [String, Integer, Time, nil] time The created time.
+    #   If `time` is `Integer`, it is used as UNIX time.
+    def created_time=(time)
+      super(normalize_time(time))
+    end
+
+    # Sets `time` as the `modified_time` attribute value.
+    #
+    # @param [String, Integer, Time, nil] time The modified time.
+    #   If `time` is `Integer`, it is used as UNIX time.
+    def modified_time=(time)
+      super(normalize_time(time))
+    end
+
+    private
+    def normalize_name(name)
+      name.to_sym
+    end
+
+    def normalize_encoding(encoding)
+      if encoding.is_a?(String)
+        encoding = Encoding.find(encoding)
+      end
+      encoding
+    end
+
+    def normalize_time(time)
+      case time
+      when String
+        Time.parse(time)
+      when Integer
+        Time.at(time).utc
+      else
+        time
+      end
+    end
+  end
+end

data/lib/chupa-text/data.rb

@@ -43,7 +43,8 @@ module ChupaText
     #   text and meta-data.
     attr_accessor :path
 
-    attr_accessor :attributes
+    # @return [Attributes] The attributes of the data.
+    attr_reader :attributes
 
     # @return [Data, nil] The source of the data. For example, text
     #   data (`hello.txt`) in archive data (`hello.tar`) have the
@@ -56,7 +57,7 @@ module ChupaText
       @size = nil
       @path = nil
       @mime_type = nil
-      @attributes = {}
+      @attributes = Attributes.new
       @source = nil
     end
 

data/lib/chupa-text/error.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2013-2014  Kouhei Sutou <kou@clear-code.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -17,4 +17,21 @@
 module ChupaText
   class Error < StandardError
   end
+
+  class EncryptedError < Error
+    attr_reader :data
+    def initialize(data)
+      @data = data
+      super("Encrypted data: <#{data.path}>(#{data.mime_type})")
+    end
+  end
+
+  class InvalidDataError < Error
+    attr_reader :data, :detail
+    def initialize(data, detail)
+      @data = data
+      @detail = detail
+      super("Invalid data: <#{data.path}>(#{data.mime_type}): <#{detail}>")
+    end
+  end
 end

data/lib/chupa-text/version.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2013-2014  Kouhei Sutou <kou@clear-code.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -15,5 +15,5 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 module ChupaText
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/test/test-attributes.rb

@@ -0,0 +1,104 @@
+# Copyright (C) 2014  Kouhei Sutou <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+class TestAttributes < Test::Unit::TestCase
+  def setup
+    @attributes = ChupaText::Attributes.new
+  end
+
+  sub_test_case("title") do
+    def test_accessor
+      assert_nil(@attributes.title)
+      @attributes.title = "Title"
+      assert_equal("Title", @attributes.title)
+    end
+  end
+
+  sub_test_case("author") do
+    def test_accessor
+      assert_nil(@attributes.author)
+      @attributes.author = "Alice"
+      assert_equal("Alice", @attributes.author)
+    end
+  end
+
+  sub_test_case("encoding") do
+    def test_string
+      @attributes.encoding = "UTF-8"
+      assert_equal(Encoding::UTF_8, @attributes.encoding)
+    end
+
+    def test_encoding
+      @attributes.encoding = Encoding::UTF_8
+      assert_equal(Encoding::UTF_8, @attributes.encoding)
+    end
+
+    def test_nil
+      @attributes.encoding = nil
+      assert_nil(@attributes.encoding)
+    end
+  end
+
+  sub_test_case("created_time") do
+    def test_string
+      @attributes.created_time = "2014-02-17T23:14:30+09:00"
+      assert_equal(Time.parse("2014-02-17T23:14:30+09:00"),
+                   @attributes.created_time)
+    end
+
+    def test_integer
+      @attributes.created_time = 1392646470
+      assert_equal(Time.parse("2014-02-17T23:14:30+09:00"),
+                   @attributes.created_time)
+    end
+
+    def test_time
+      @attributes.created_time = Time.parse("2014-02-17T23:14:30+09:00")
+      assert_equal(Time.parse("2014-02-17T23:14:30+09:00"),
+                   @attributes.created_time)
+    end
+
+    def test_nil
+      @attributes.created_time = nil
+      assert_nil(@attributes.created_time)
+    end
+  end
+
+  sub_test_case("modified_time") do
+    def test_string
+      @attributes.modified_time = "2014-02-17T23:14:30+09:00"
+      assert_equal(Time.parse("2014-02-17T23:14:30+09:00"),
+                   @attributes.modified_time)
+    end
+
+    def test_integer
+      @attributes.modified_time = 1392646470
+      assert_equal(Time.parse("2014-02-17T23:14:30+09:00"),
+                   @attributes.modified_time)
+    end
+
+    def test_time
+      @attributes.modified_time = Time.parse("2014-02-17T23:14:30+09:00")
+      assert_equal(Time.parse("2014-02-17T23:14:30+09:00"),
+                   @attributes.modified_time)
+    end
+
+    def test_nil
+      @attributes.modified_time = nil
+      assert_nil(@attributes.modified_time)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chupa-text
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Kouhei Sutou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-16 00:00:00.000000000 Z
+date: 2014-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,6 +127,7 @@ files:
 - lib/chupa-text/input-data.rb
 - lib/chupa-text/mime-type-registry.rb
 - lib/chupa-text/default-logger.rb
+- lib/chupa-text/attributes.rb
 - lib/chupa-text.rb
 - doc/text/decomposer.md
 - doc/text/command-line.md
@@ -150,6 +151,7 @@ files:
 - test/fixture/command/chupa-text/no-decomposer.conf
 - test/fixture/command/chupa-text/hello.txt
 - test/fixture/extractor/hello.txt
+- test/test-attributes.rb
 - test/test-external-command.rb
 - test/test-size-parser.rb
 - test/decomposers/test-csv.rb