csjparser 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: c89df4531c21d110ab951aa3c212c65331a115d8
4
+ data.tar.gz: 2621a364d0ebdd86b0c3ce67d877f717acfb78d9
5
+ SHA512:
6
+ metadata.gz: 5d5e3ffcf09ea10f06d8e777f0ddd6de223905c56794cf23df5c3341901acb2e85652c2b0d04ebadf34bc68b147d986f391dd28fdfec9d734795cba4dc2a174b
7
+ data.tar.gz: 3a9057ecc4f3e78526f795bfb7f2b9445456ec6f8ced5557b2154f6bf18c608445deb0a4978519d57d948dce51362e8e60066dee4b1400f01202e897849cc7ac
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.2.4
5
+ before_install: gem install bundler -v 1.12.5
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at ezapata@altavistaed.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in csjparser.gemspec
4
+ gemspec
5
+
6
+ gem 'coveralls', require: false
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 esteban zapata
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,81 @@
1
+ # Csjparser
2
+
3
+ [![Build Status](https://travis-ci.org/estebanz01/csjparser.svg?branch=master)](https://travis-ci.org/estebanz01/csjparser)
4
+ [![Coverage Status](https://coveralls.io/repos/github/estebanz01/csjparser/badge.svg?branch=master)](https://coveralls.io/github/estebanz01/csjparser?branch=master)
5
+
6
+ CSJ Parser is a gem that allows you parse a [Comma Separated JSON](http://www.kirit.com/Comma%20Separated%20JSON) file into a Hash ruby object.
7
+ The idea of this project is to have fun and learn a lot while coding in ruby.
8
+
9
+ ## Installation
10
+
11
+ Add this line to your application's Gemfile:
12
+
13
+ ```ruby
14
+ gem 'csjparser'
15
+ ```
16
+
17
+ And then execute:
18
+
19
+ $ bundle
20
+
21
+ Or install it yourself as:
22
+
23
+ $ gem install csjparser
24
+
25
+ ## Usage
26
+
27
+ Simply require the csjparser and use the Parser or ValueChecker class as follows:
28
+
29
+ ```ruby
30
+ require 'csjparser'
31
+
32
+ filepath = '/dir/of/file.csj'
33
+
34
+ # This will give you an object like:
35
+ # [{ key: value1 }, ..., { key: valueN }]
36
+ array_of_hashes = Csjparser::Parse.new(filepath).parse_document
37
+
38
+ # You can also use the ValueChecker class to see how an object respond to a value.
39
+ value_a = 'weirdString'
40
+ value_b = '34'
41
+ value_c = '2015-06-31'
42
+
43
+ Csjparser::ValueChecker.new(value_a).integer? # false
44
+ Csjparser::ValueChecker.new(value_b).integer? # true
45
+ Csjparser::ValueChecker.new(value_c).integer? # false
46
+
47
+ Csjparser::ValueChecker.new(value_a).date? # false
48
+ Csjparser::ValueChecker.new(value_b).date? # false
49
+ Csjparser::ValueChecker.new(value_c).date? true
50
+
51
+ # The methods availables in ValueChecker class are:
52
+ # bool?
53
+ # nil?
54
+ # date?
55
+ # array?
56
+ # integer?
57
+ # float?
58
+ ```
59
+
60
+ ## Known issues (TODO list)
61
+
62
+ * It does not support nested arrays.
63
+ * It does not parse valid hexadecimal digits.
64
+ * The valid ["[1, 2, 3, 4]"] is not supported.
65
+ * It does not create a valid CSJ file from a ruby object.
66
+
67
+ ## Development
68
+
69
+ 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.
70
+
71
+ 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).
72
+
73
+ ## Contributing
74
+
75
+ Bug reports and pull requests are welcome on GitHub at https://github.com/estebanz01/csjparser. 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.
76
+
77
+
78
+ ## License
79
+
80
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
81
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "csjparser"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/csjparser.gemspec ADDED
@@ -0,0 +1,32 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'csjparser/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'csjparser'
8
+ spec.version = Csjparser::VERSION
9
+ spec.authors = ['Esteban Zapata']
10
+ spec.email = ['estebanz01@outlook.com']
11
+
12
+ spec.summary = 'Comma Separated JSON parser made in ruby.'
13
+ spec.homepage = 'https://github.com/estebanz01/csjparser'
14
+ spec.license = 'MIT'
15
+
16
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
17
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
18
+ if spec.respond_to?(:metadata)
19
+ spec.metadata['allowed_push_host'] = 'https://rubygems.org'
20
+ else
21
+ raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
22
+ end
23
+
24
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
25
+ spec.bindir = 'exe'
26
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
27
+ spec.require_paths = ['lib']
28
+
29
+ spec.add_development_dependency 'bundler', '~> 1.12'
30
+ spec.add_development_dependency 'rake', '~> 10.0'
31
+ spec.add_development_dependency 'rspec', '~> 3.4'
32
+ end
data/lib/csjparser.rb ADDED
@@ -0,0 +1,17 @@
1
+ require "csjparser/version"
2
+ require 'date'
3
+
4
+ require 'csjparser/reader'
5
+ require 'csjparser/value_checker'
6
+ require 'csjparser/parser'
7
+
8
+ module Csjparser
9
+ end
10
+
11
+ # References
12
+ # http://stackoverflow.com/questions/5661466/test-if-string-is-a-number-in-ruby-on-rails
13
+ # http://stackoverflow.com/a/21815132
14
+ # http://stackoverflow.com/a/1034499
15
+ # http://zaiste.net/2012/07/string_to_boolean_in_ruby/
16
+ # http://rorbservations.com/post/136975265334/each-with-object-vs-tap-plus-each
17
+ # http://stackoverflow.com/a/32896689
@@ -0,0 +1,80 @@
1
+ # rubocop:disable Style/DoubleNegation
2
+
3
+ module Csjparser
4
+ class Parser
5
+ attr_reader :filepath
6
+
7
+ def initialize(filepath)
8
+ @filepath = filepath
9
+ end
10
+
11
+ def parse_document
12
+ parsed_document = []
13
+ Reader.read(filepath) do |file|
14
+ keys = file.gets.gsub(/("|'|\s)/, '').chomp.split(',')
15
+
16
+ file.each_line do |line|
17
+ parsed_values = process_line(line)
18
+
19
+ parsed_document << build_hash(keys, parsed_values)
20
+ end
21
+ end
22
+
23
+ parsed_document
24
+ end
25
+
26
+ def process_line(line)
27
+ values = line.gsub(', ', ',').chomp
28
+
29
+ # Identify arrays before splitting a file and replace commas with {array} strings.
30
+ values = values.gsub(/(?:\[|(?!^)\G){1}[^,\]]*\K,/, '{array}').split(',')
31
+
32
+ values.map do |value|
33
+ # Trim first and last double quotes.
34
+ parse(value.gsub(/(^"|"$)/, ''))
35
+ end
36
+ end
37
+ private :process_line
38
+
39
+ def build_hash(keys, parsed_values)
40
+ {}.tap do |memo|
41
+ keys.each_with_index do |key, index|
42
+ memo[key.to_sym] = parsed_values[index]
43
+ end
44
+ end
45
+ end
46
+ private :build_hash
47
+
48
+ def parse(value)
49
+ object = Csjparser::ValueChecker.new(value)
50
+
51
+ case
52
+ when object.nil?
53
+ nil
54
+ when object.bool?
55
+ !!(value =~ /^(true|yes)/i)
56
+ when object.integer?
57
+ value.to_i
58
+ when object.float?
59
+ Float(value)
60
+ when object.date?
61
+ Date.parse(value)
62
+ when object.array?
63
+ parse_array(value)
64
+ else
65
+ value
66
+ end
67
+ end
68
+ private :parse
69
+
70
+ def parse_array(value)
71
+ array_values = value.gsub(/(^\[|\]$)/, '').split('{array}')
72
+
73
+ array_values.map do |element|
74
+ raise 'nested arrays not supported' if Csjparser::ValueChecker.new(element).array?
75
+ parse(element.gsub(/(^"|"$)/, ''))
76
+ end
77
+ end
78
+ private :parse_array
79
+ end
80
+ end
@@ -0,0 +1,20 @@
1
+ module Csjparser
2
+ class Reader
3
+ def self.read(filepath)
4
+ validate(filepath)
5
+
6
+ # Read-only to keep consistency.
7
+ File.open(filepath, 'r') do |file|
8
+ yield file
9
+ end
10
+ end
11
+
12
+ def self.validate(filepath)
13
+ errors = []
14
+ errors << "File #{filepath} does not exists." unless File.exist?(filepath)
15
+ errors << "File #{filepath} is executable. Why?" if File.executable?(filepath)
16
+ errors << "File #{filepath} is not readable." unless File.readable?(filepath)
17
+ raise(StandardError, errors.join("\n")) unless errors.empty?
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,40 @@
1
+ # We want to avoid the use of truthy values while guessing the type.
2
+ # rubocop:disable Style/DoubleNegation
3
+
4
+ module Csjparser
5
+ class ValueChecker
6
+ attr_reader :object
7
+
8
+ def initialize(object)
9
+ @object = object
10
+ end
11
+
12
+ def bool?
13
+ !!(object =~ /^(true|yes)$/i || object =~ /^(false|no)$/i)
14
+ end
15
+
16
+ def integer?
17
+ !!(!object.empty? && object !~ /\D/)
18
+ end
19
+
20
+ def float?
21
+ !!Float(object)
22
+ rescue
23
+ false
24
+ end
25
+
26
+ def date?
27
+ !!Date.parse(object)
28
+ rescue
29
+ false
30
+ end
31
+
32
+ def nil?
33
+ object == 'null'
34
+ end
35
+
36
+ def array?
37
+ !!(object =~ /(^\[|\]$)/)
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,3 @@
1
+ module Csjparser
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,103 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: csjparser
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Esteban Zapata
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-06-30 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.12'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.12'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.4'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.4'
55
+ description:
56
+ email:
57
+ - estebanz01@outlook.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".rspec"
64
+ - ".travis.yml"
65
+ - CODE_OF_CONDUCT.md
66
+ - Gemfile
67
+ - LICENSE.txt
68
+ - README.md
69
+ - Rakefile
70
+ - bin/console
71
+ - bin/setup
72
+ - csjparser.gemspec
73
+ - lib/csjparser.rb
74
+ - lib/csjparser/parser.rb
75
+ - lib/csjparser/reader.rb
76
+ - lib/csjparser/value_checker.rb
77
+ - lib/csjparser/version.rb
78
+ homepage: https://github.com/estebanz01/csjparser
79
+ licenses:
80
+ - MIT
81
+ metadata:
82
+ allowed_push_host: https://rubygems.org
83
+ post_install_message:
84
+ rdoc_options: []
85
+ require_paths:
86
+ - lib
87
+ required_ruby_version: !ruby/object:Gem::Requirement
88
+ requirements:
89
+ - - ">="
90
+ - !ruby/object:Gem::Version
91
+ version: '0'
92
+ required_rubygems_version: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ requirements: []
98
+ rubyforge_project:
99
+ rubygems_version: 2.4.8
100
+ signing_key:
101
+ specification_version: 4
102
+ summary: Comma Separated JSON parser made in ruby.
103
+ test_files: []