csv2schema 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTA1OWRiNjIxMmQ2YjdiZmMxM2M0MzkzOTI5OWNiNjE5Y2NmNGQzZA==
+  data.tar.gz: !binary |-
+    Nzk0MGUxODRlMTVlZmY4Y2VlNDY2ZmQ2MGQ3ZGI1ZWY4ZDQzMjEyOA==
+SHA512:
+  metadata.gz: !binary |-
+    NjE1YjMzZDIxZGQyMDllZjMyNWU2MDBhZmVmMmZjMDE3ODA0YmMzMDk1YzY5
+    MGQ5YzFiOWEwOWU3MTYwYTJkYzdlN2YzYWE4OTY1MjFhZGI0MDdlMGNmYTNh
+    Mzk1MGU2N2EyMDNmYjZlMDVhMGE1MTg2N2IwYzJkNTVkMmNmYWI=
+  data.tar.gz: !binary |-
+    NmUwNTQ5ZTU0MjNhNTY5MmQ4ZWNmMWUyNGFkZDk1M2M2YTYyYzgxZGVhNGI0
+    ZTViNzY3NGZmMzA2NmI3ZTBkNGVkNDc1MjQ5ZTJkMTU4NDZhNDJhOGQzYzU1
+    N2RhZmIzZjdlNWJlY2YzMWUzNDM0MWI2NzcxMTdmMDEzMDdmM2E=

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+- 2.3.1
+before_install: gem install bundler -v 1.11.2
+deploy:
+  provider: rubygems
+  api_key:
+    secure: YZE/IjG3M/2QDaOHFHEMa34joShMud94A7CuvmNfQpqnpe1GntS9m84X58IAzFw6TbiJZdaZSdcMEjlskqepkw/aogwycx32t+bYSlgXY0DSz1sEu9lw3mQUwUzFyiNbpRUiELX3MsEpf72ZoFUnvKU24LHYb1r2+zkQcFqpZVVlzA0k24E10oYMz3MU6hjBvAJEuMfzVdjZo6oubl8Lx6Kz3YUxZUxLGajdrvoqKhrp/h9Eh0OHz53Psg+CK9Y0UoxQNFeUt/JBJUMwAHuHsIXDxFW4VVvYxrEiZ12H7dd7nbj0roR4I/YwcSyk5UIbWGcM0OTWCAVqruVD0TINj4gTrREO5zA6RP9aWa7PBJe1Ddp6jQBlFWCYm0mZMe/57hHA9jklVRFirggMAOsB6qzuGda7lElqqbKAUaJDY7mQAmSn3F8tuQDrRJmmrC2jogtrwgCpzPihLXGlSwmcACmcJ5C6mAuEtxcd1+ZE9bHotIPUVnnfHyshP0frIjkrcFcufl4+gCZhzcux81usGerSuM4QmfT8eyhkPSf7mZj2PKHt2ErUdfmm37HHt4WxGbes69ewvlZuNQIyonBV/dGoYWOwqYMAwxj5Furyk8R1jo2Fk5co3OwsoHEHo4axUDT4dCoUfq1A49KEGefvCRnTXtBnl2/B32u+debtMEU=
+  gem: csv2schema
+  on:
+    tags: true
+    repo: theodi/csv2schema

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at pezholio@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in csv2schema.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 pezholio
+
+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,72 @@
+[![Build Status](http://img.shields.io/travis/theodi/csv2schema.svg?style=flat-square)](https://travis-ci.org/theodi/csv2schema)
+[![Dependency Status](http://img.shields.io/gemnasium/theodi/csv2schema.svg?style=flat-square)](https://gemnasium.com/theodi/csv2schema)
+[![Code Climate](http://img.shields.io/codeclimate/github/theodi/csv2schema.svg?style=flat-square)](https://codeclimate.com/github/theodi/csv2schema)
+[![Gem Version](http://img.shields.io/gem/v/csv2schema.svg?style=flat-square)](https://rubygems.org/gems/csv2schema)
+[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://theodi.mit-license.org)
+
+# Csv2schema
+
+Automagically generate a [JSON table schema](http://specs.frictionlessdata.io/json-table-schema/) file to go with a CSV file. Inspired by Stuart Lowe's [JSON Table Schema Generator](https://odileeds.github.io/JSONSchema/) at [ODI Leeds](https://leeds.theodi.org).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'csv2schema'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install csv2schema
+
+## Usage
+
+Require the gem (if you haven't already):
+
+```ruby
+require 'csv2schema'
+```
+
+Initialise the CSV with a file:
+
+```ruby
+csv = Csv2schema::CSV.new(File.open("path/to/file.csv"))
+```
+
+Or with a URL:
+
+```ruby
+csv = Csv2schema::CSV.new("http://example.org/file.csv")
+```
+
+Or with an IO-style object (i.e StringIO):
+
+```ruby
+csv = Csv2schema::CSV.new(StringIO.new( my_data_in_a_string ))
+```
+
+Then get the schema as a JSON string:
+
+```ruby
+csv.schema
+#=> "{\"fields\":[{\"name\":\"Foo\",\"title\":\"Foo\",\"constraints\":{\"required\":false,\"type\":\"http://www.w3.org/2001/XMLSchema#int\"}},{\"name\":\"Bar\",\"title\":\"Bar\",\"constraints\":{\"required\":true,\"type\":\"http://www.w3.org/2001/XMLSchema#int\"}},{\"name\":\"Baz\",\"title\":\"Baz\",\"constraints\":{\"required\":true,\"type\":\"http://www.w3.org/2001/XMLSchema#int\"}}]}"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/theodi/csv2schema. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "csv2schema"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/csv2schema.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'csv2schema/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "csv2schema"
+  spec.version       = Csv2schema::VERSION
+  spec.authors       = ["pezholio"]
+  spec.email         = ["pezholio@gmail.com"]
+
+  spec.summary       = "Generate a JSON table schema from a CSV file"
+  spec.homepage      = "https://github.com/theodi/csv2schema"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "csvlint", "~> 0.3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+end

data/lib/csv2schema.rb

@@ -0,0 +1,14 @@
+require "csvlint"
+require "json"
+
+require "csv2schema/version"
+
+require "csv2schema/formats"
+require "csv2schema/required"
+require "csv2schema/schema"
+
+require "csv2schema/csv"
+
+module Csv2schema
+  # Your code goes here...
+end

data/lib/csv2schema/csv.rb

@@ -0,0 +1,22 @@
+module Csv2schema
+  class CSV
+    include Csv2schema::Formats
+    include Csv2schema::Required
+    include Csv2schema::Schema
+
+    def initialize(io)
+      @validator = Csvlint::Validator.new(io)
+      @column_headers = get_column_headers
+      apply_formats
+      apply_required
+    end
+
+    private
+
+      def get_column_headers
+        headers = @validator.data.first
+        Hash[headers.each_with_index.map { |col, i| [col, {'name' => col}] }]
+      end
+
+  end
+end

data/lib/csv2schema/formats.rb

@@ -0,0 +1,30 @@
+module Csv2schema
+  module Formats
+
+    def apply_formats
+      @column_headers.each_with_index { |(k,v),i| @column_headers[k]['format'] = formats[i] }
+    end
+
+    private
+
+      def formats
+        @formats ||= begin
+          formats = @validator.instance_variable_get("@formats")
+
+          formats.map do |formats|
+            get_format(formats)
+          end
+        end
+      end
+
+      def get_format(candidates)
+        total = candidates.values.reduce(:+)
+        best = :string
+        candidates.each do |k,v|
+          best = k if v > (total * 0.8)
+        end
+        best
+      end
+
+  end
+end

data/lib/csv2schema/required.rb

@@ -0,0 +1,20 @@
+module Csv2schema
+  module Required
+
+    def apply_required
+      @column_headers.each_with_index { |(k,v),i| @column_headers[k]['required'] = required[i] }
+    end
+
+    private
+
+      def required
+        @required ||= begin
+          data = @validator.data
+          data.transpose.each_with_index.map do |col|
+            col.select { |c| c.blank? }.count == 0
+          end
+        end
+      end
+
+  end
+end

data/lib/csv2schema/schema.rb

@@ -0,0 +1,29 @@
+module Csv2schema
+  module Schema
+
+    def schema
+      fields = @column_headers.map do |key,col|
+        {
+          name: col['name'],
+          title: col['name'],
+          constraints: {
+            required: col['required'],
+            type: get_type(col['format'])
+          }
+        }
+      end
+
+      {
+        "fields": fields
+      }.to_json
+    end
+
+    def get_type(format)
+      {
+        string: 'http://www.w3.org/2001/XMLSchema#string',
+        numeric: 'http://www.w3.org/2001/XMLSchema#int'
+      }[format]
+    end
+
+  end
+end

data/lib/csv2schema/version.rb

@@ -0,0 +1,3 @@
+module Csv2schema
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: csv2schema
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pezholio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: csvlint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+description: 
+email:
+- pezholio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- csv2schema.gemspec
+- lib/csv2schema.rb
+- lib/csv2schema/csv.rb
+- lib/csv2schema/formats.rb
+- lib/csv2schema/required.rb
+- lib/csv2schema/schema.rb
+- lib/csv2schema/version.rb
+homepage: https://github.com/theodi/csv2schema
+licenses:
+- MIT
+metadata:
+  allowed_push_host: ! 'TODO: Set to ''http://mygemserver.com'''
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Generate a JSON table schema from a CSV file
+test_files: []