red-datasets 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 21e6ccf743e4603d55a8c628213d3e8278b4c9a29f4914887cc4f148065e6edc
+  data.tar.gz: 5d45f1ed6e5e2ec6620243641322323b78d22bb52c1f06ed3b0a0fe2555a7dd7
+SHA512:
+  metadata.gz: 791bb9a4953a6c7667e95ff8b479180e91ce25f4f090a55a119118884caf59482ec6cff3993486427e85156228041c2ece0734312210079a7a057067d709d277
+  data.tar.gz: 8f76e7a5d781d85767d1b476dac26e9b954d556e9e54d689b1cdbe0f881a8f165b6188cce072857b19b3f7c5f57537b82b962fb7c74a35102aad396cb9617ddd

data/.yardopts

@@ -0,0 +1,6 @@
+--output-dir doc/reference/en
+--markup markdown
+--markup-provider kramdown
+lib/**/*.rb
+-
+doc/text/**/*

data/Gemfile

@@ -0,0 +1,5 @@
+# -*- ruby -*-
+
+source "https://rubygems.org/"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2017 Kouhei Sutou <kou@clear-code.com>
+
+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 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

@@ -0,0 +1,42 @@
+# README
+
+## Name
+
+Red Datasets
+
+## Description
+
+Red Datasets provides classes that provide common datasets such as iris dataset.
+
+You can use datasets easily because you can access each dataset with multiple ways such as `#each` and Apache Arrow Record Batch.
+
+## Install
+
+```console
+% gem install red-datasets
+```
+
+## Usage
+
+Here is an example to access iris dataset by `#each`:
+
+```ruby
+require "datasets"
+
+iris = Datasets::Iris.new
+iris.each do |record|
+  p [
+     record.sepal_length,
+     record.sepal_width,
+     record.petal_length,
+     record.petal_width,
+     record.class,
+  ]
+  # [5.1, 3.5, 1.4, 0.2, "Iris-setosa"]
+  # [7.0, 3.2, 4.7, 1.4, "Iris-versicolor"]
+end
+```
+
+## License
+
+The MIT license. See `LICENSE.txt` for details.

data/Rakefile

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+
+require "rubygems"
+require "bundler/gem_helper"
+
+base_dir = File.join(File.dirname(__FILE__))
+
+helper = Bundler::GemHelper.new(base_dir)
+def helper.version_tag
+  version
+end
+
+helper.install
+spec = helper.gemspec
+
+desc "Run tests"
+task :test do
+  ruby("test/run-test.rb")
+end
+
+task default: :test

data/doc/text/news.md

@@ -0,0 +1,7 @@
+# News
+
+## 0.0.1 2018-01-08
+
+### Improvements
+
+  * `Datasets::Iris`: Added a dataset for iris.

data/lib/datasets/dataset.rb

@@ -0,0 +1,42 @@
+require "fileutils"
+require "open-uri"
+require "pathname"
+
+require_relative "metadata"
+
+module Datasets
+  class Dataset
+    attr_reader :metadata
+    def initialize
+      @metadata = Metadata.new
+    end
+
+    private
+    def cache_dir_path
+      case RUBY_PLATFORM
+      when /mswin/, /mingw/
+        base_dir = ENV["LOCALAPPDATA"] || "~/AppData"
+      when /darwin/
+        base_dir = "~/Library/Caches"
+      else
+        base_dir = ENV["XDG_CACHE_HOME"] || "~/.cache"
+      end
+      Pathname(base_dir).expand_path + "red-datasets" + metadata.name
+    end
+
+    def download(output_path, url)
+      url = URI.parse(url) unless url.is_a?(URI::Generic)
+      output_path.parent.mkpath
+      begin
+        url.open do |input|
+          output_path.open("wb") do |output|
+            IO.copy_stream(input, output)
+          end
+        end
+      rescue
+        FileUtils.rm_f(output_path)
+        raise
+      end
+    end
+  end
+end

data/lib/datasets/iris.rb

@@ -0,0 +1,55 @@
+require "csv"
+
+require_relative "dataset"
+
+module Datasets
+  class Iris < Dataset
+    Record = Struct.new(:sepal_length,
+                        :sepal_width,
+                        :petal_length,
+                        :petal_width,
+                        :class)
+
+    def initialize
+      super()
+      @metadata.name = "iris"
+      @metadata.url = "https://archive.ics.uci.edu/ml/datasets/Iris"
+      @metadata.description = lambda do
+        read_names
+      end
+    end
+
+    def each
+      return to_enum(__method__) unless block_given?
+
+      open_data do |csv|
+        csv.each do |row|
+          next if row[0].nil?
+          record = Record.new(*row)
+          yield(record)
+        end
+      end
+    end
+
+    private
+    def open_data
+      data_path = cache_dir_path + "iris.csv"
+      unless data_path.exist?
+        data_url = "https://archive.ics.uci.edu/ml/machine-learning-databases/iris/iris.data"
+        download(data_path, data_url)
+      end
+      CSV.open(data_path, converters: [:numeric]) do |csv|
+        yield(csv)
+      end
+    end
+
+    def read_names
+      names_path = cache_dir_path + "iris.names"
+      unless names_path.exist?
+        names_url = "https://archive.ics.uci.edu/ml/machine-learning-databases/iris/iris.names"
+        download(names_path, names_url)
+      end
+      names_path.read
+    end
+  end
+end

data/lib/datasets/metadata.rb

@@ -0,0 +1,14 @@
+module Datasets
+  class Metadata < Struct.new(:name,
+                              :url,
+                              :license,
+                              :description)
+    def description
+      description_raw = super
+      if description_raw.respond_to?(:call)
+        self.description = description_raw = description_raw.call
+      end
+      description_raw
+    end
+  end
+end

data/lib/datasets/version.rb

@@ -0,0 +1,3 @@
+module Datasets
+  VERSION = "0.0.1"
+end

data/lib/datasets.rb

@@ -0,0 +1,3 @@
+require "datasets/version"
+
+require "datasets/iris"

data/red-datasets.gemspec

@@ -0,0 +1,42 @@
+# -*- ruby -*-
+
+clean_white_space = lambda do |entry|
+  entry.gsub(/(\A\n+|\n+\z)/, '') + "\n"
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "lib"))
+require "datasets/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "red-datasets"
+  spec.version = Datasets::VERSION
+  spec.homepage = "https://github.com/red-data-tools/red-datasets"
+  spec.authors = ["tomisuker", "Kouhei Sutou"]
+  spec.email = ["tomisuker16@gmail.com", "kou@clear-code.com"]
+
+  readme = File.read("README.md")
+  readme.force_encoding("UTF-8")
+  entries = readme.split(/^\#\#\s(.*)$/)
+  clean_white_space.call(entries[entries.index("Description") + 1])
+  description = clean_white_space.call(entries[entries.index("Description") + 1])
+  spec.summary, spec.description, = description.split(/\n\n+/, 3)
+  spec.license = "MIT"
+  spec.files = [
+    "README.md",
+    "LICENSE.txt",
+    "Rakefile",
+    "Gemfile",
+    "#{spec.name}.gemspec",
+  ]
+  spec.files += [".yardopts"]
+  spec.files += Dir.glob("lib/**/*.rb")
+  spec.files += Dir.glob("image/*.*")
+  spec.files += Dir.glob("doc/text/*")
+  spec.test_files += Dir.glob("test/**/*")
+
+  spec.add_development_dependency("bundler")
+  spec.add_development_dependency("rake")
+  spec.add_development_dependency("test-unit")
+  spec.add_development_dependency("yard")
+  spec.add_development_dependency("kramdown")
+end

data/test/helper.rb

@@ -0,0 +1,3 @@
+require "datasets"
+
+require "test-unit"

data/test/run-test.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+$VERBOSE = true
+
+require "pathname"
+
+base_dir = Pathname.new(__FILE__).dirname.parent.expand_path
+
+lib_dir = base_dir + "lib"
+test_dir = base_dir + "test"
+
+$LOAD_PATH.unshift(lib_dir.to_s)
+
+require_relative "helper"
+
+exit(Test::Unit::AutoRunner.run(true, test_dir.to_s))

data/test/test-iris.rb

@@ -0,0 +1,32 @@
+class IrisTest < Test::Unit::TestCase
+  def setup
+    @dataset = Datasets::Iris.new
+  end
+
+  def record(*args)
+    Datasets::Iris::Record.new(*args)
+  end
+
+  test("#each") do
+    records = @dataset.each.to_a
+    assert_equal([
+                   150,
+                   record(5.1, 3.5, 1.4, 0.2, "Iris-setosa"),
+                   record(5.9, 3.0, 5.1, 1.8, "Iris-virginica"),
+                 ],
+                 [
+                   records.size,
+                   records[0],
+                   records[-1],
+                 ])
+  end
+
+  sub_test_case("#metadata") do
+    test("#description") do
+      description = @dataset.metadata.description
+      assert do
+        description.start_with?("1. Title: Iris Plants Database")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: red-datasets
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- tomisuker
+- Kouhei Sutou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'You can use datasets easily because you can access each dataset with
+  multiple ways such as `#each` and Apache Arrow Record Batch.
+
+'
+email:
+- tomisuker16@gmail.com
+- kou@clear-code.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/text/news.md
+- lib/datasets.rb
+- lib/datasets/dataset.rb
+- lib/datasets/iris.rb
+- lib/datasets/metadata.rb
+- lib/datasets/version.rb
+- red-datasets.gemspec
+- test/helper.rb
+- test/run-test.rb
+- test/test-iris.rb
+homepage: https://github.com/red-data-tools/red-datasets
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Red Datasets provides classes that provide common datasets such as iris dataset.
+test_files:
+- test/test-iris.rb
+- test/run-test.rb
+- test/helper.rb