dataset_explorer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d8d37acf8dbd69347ee5d469c4c6ee4a70b3c8a86a74ec30e7d92518a2b2943f
+  data.tar.gz: 291900362c27de4d230b492e58983a9f8ac3c44b0a52cdcabd28636ee5536416
+SHA512:
+  metadata.gz: 9aff0c19a1a1fdaae24faa517a488e7611c26f445d80db30da997f3aa60a1ee583d30f4215cb3b48076b5bc8c51d166f01724cc322c77e2cedcc0ef5adec32be
+  data.tar.gz: 007b2822c83146392d54429f63b43038ce5cf09e3d41b9e51d8bc81592fc617022c4b6af5e8e29617b928328badb4bbb205397f41bcd08452e8efff29aee2711

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,66 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/MethodLength:
+  Exclude:
+   - 'db/migrate/**.rb'
+
+Layout/LineLength:
+  Max: 100
+  Exclude:
+   - 'db/seeds.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: 'exception'
+
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+RSpec:
+  Exclude:
+    - 'spec/factories/**/*'
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - 'node_modules/**/*'
+    - 'script/**/*'
+    - 'log/**/*'
+    - 'docker/**/*'
+    - 'doc/**/*'
+    - 'bin/**/*'
+    - 'Rakefile'
+    - 'config.ru'
+    - 'config/**/*'
+    - 'db/schema.rb'
+    - 'node_modules/**/*'
+    - 'vendor/**/*'

data/.travis.yml

@@ -0,0 +1,11 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4
+
+script:
+  - RAILS_ENV=test bundle exec rspec
+  - bundle exec rubocop --version
+  - bundle exec rubocop -a

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at marcelo.jacobus@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dataset_explorer.gemspec
+gemspec
+
+gem 'awesome_print'
+gem 'coveralls', '~> 0.8.23'
+gem 'rake', '~> 12.0'
+gem 'reek'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '0.79.0'
+gem 'rubocop-performance'
+gem 'rubocop-rspec'
+gem 'simplecov', '~> 0.16.1'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Marcelo Jacobus
+
+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,185 @@
+# DatasetExplorer
+
+[![Build Status](https://travis-ci.org/mjacobus/dataset_explorer.svg?branch=master)](https://travis-ci.org/mjacobus/dataset_explorer)
+[![Coverage Status](https://coveralls.io/repos/github/mjacobus/dataset_explorer/badge.svg?branch=master)](https://coveralls.io/github/mjacobus/dataset_explorer?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ae41e3facbadaabaa463/maintainability)](https://codeclimate.com/github/mjacobus/dataset_explorer/maintainability)
+
+Explores a data set and keep track of all the fields ever returned.
+
+The idea is to collect all the fields from a dataset, including the ones nested from an API that will omit some fields when they are `null`, or even to make sure that the fields listed in the documentation (or not listed at all) can be explained by the output.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dataset_explorer'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dataset_explorer
+
+## Usage
+
+```ruby
+def some_method_that_pulls_data(args)
+  response = client.get('url', args)
+  DatasetExplorer::Collector.instance.collect('type-of-request', result)
+end
+
+# somewhere
+
+p DatasetExplorer::Collector.explain('type-of-request')
+p DatasetExplorer::Collector.explain_all
+```
+
+
+```ruby
+require 'bundler/setup'
+require 'open-uri'
+require 'json'
+require 'dataset_explorer'
+require 'awesome_print'
+
+urls = {
+  github: 'https://pages.github.com/versions.json',
+  github_repo_contents: 'https://api.github.com/repos/mjacobus/rubyjobsbrazil/contents',
+}
+
+COLLECTOR = DatasetExplorer::Collector.instance
+
+urls.each do |provider, url|
+  data = [JSON.parse(open(url).read)].flatten
+
+  data.each do |item|
+    COLLECTOR.collect(provider, item)
+  end
+end
+
+explanation = COLLECTOR.explain_all
+```
+
+Explanation will be:
+
+```ruby
+{
+  github: %w[
+    jekyll
+    jekyll-sass-converter
+    kramdown
+    jekyll-commonmark-ghpages
+    liquid
+    rouge
+    github-pages-health-check
+    jekyll-redirect-from
+    jekyll-sitemap
+    jekyll-feed
+    jekyll-gist
+    jekyll-paginate
+    jekyll-coffeescript
+    jekyll-seo-tag
+    jekyll-github-metadata
+    jekyll-avatar
+    jekyll-remote-theme
+    jemoji
+    jekyll-mentions
+    jekyll-relative-links
+    jekyll-optional-front-matter
+    jekyll-readme-index
+    jekyll-default-layout
+    jekyll-titles-from-headings
+    jekyll-swiss
+    minima
+    jekyll-theme-primer
+    jekyll-theme-architect
+    jekyll-theme-cayman
+    jekyll-theme-dinky
+    jekyll-theme-hacker
+    jekyll-theme-leap-day
+    jekyll-theme-merlot
+    jekyll-theme-midnight
+    jekyll-theme-minimal
+    jekyll-theme-modernist
+    jekyll-theme-slate
+    jekyll-theme-tactile
+    jekyll-theme-time-machine
+    ruby
+    github-pages
+    html-pipeline
+    sass
+    safe_yaml
+    nokogiri
+  ],
+  github_repo: [
+    'name',
+    'path',
+    'sha',
+    'size',
+    'url',
+    'html_url',
+    'git_url',
+    'download_url',
+    'type',
+    '_links.self',
+    '_links.git',
+    '_links.html'
+  ]
+}
+```
+
+```ruby
+data = {
+  user: {
+    first_name: 'John',
+    last_name: 'Doe',
+    achievements: [
+      {
+        headline: '10 nights with no sleep',
+        tag: 'amazing'
+      },
+      {
+        headline: 'read 2 books in 6 hours',
+        tag: 'nerd'
+      }
+    ]
+  }
+}
+
+DatasetExplorer::Collector.instance.collect(:achievements, data)
+result = DatasetExplorer::Collector.explain_all(:achievements)
+
+# result is:
+
+[
+  "user.first_name",
+  "user.last_name",
+  "user.achievements.[].headline",
+  "user.achievements.[].tag"
+]
+```
+
+Or if you try like this
+
+## 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/mjacobus/dataset_explorer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/mjacobus/dataset_explorer/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DatasetExplorer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mjacobus/dataset_explorer/blob/master/CODE_OF_CONDUCT.md).

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 "dataset_explorer"
+
+# 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(__FILE__)

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/dataset_explorer.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/dataset_explorer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dataset_explorer'
+  spec.version       = DatasetExplorer::VERSION
+  spec.authors       = ['Marcelo Jacobus']
+  spec.email         = ['marcelo.jacobus@gmail.com']
+
+  spec.summary       = 'Explore and maps fields from a dataset - I.E. Api response'
+  spec.description   = 'Explore and maps fields from a dataset - I.E. Api response'
+  spec.homepage      = 'https://github.com/mjacobus/dataset_explorer'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/mjacobus/dataset_explorer'
+  spec.metadata['changelog_uri'] = 'https://github.com/mjacobus/dataset_explorer'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/dataset_explorer.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'dataset_explorer/version'
+require 'dataset_explorer/item_collector'
+require 'dataset_explorer/collector'
+
+module DatasetExplorer
+  class Error < StandardError; end
+end

data/lib/dataset_explorer/collector.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module DatasetExplorer
+  class Collector
+    def self.instance
+      @instance ||= new
+    end
+
+    def initialize
+      @collectors = {}
+    end
+
+    def collect(type, item)
+      collector_for(type).add(item)
+    end
+
+    def explain_all
+      @collectors.keys.map do |key|
+        [key, explain(key)]
+      end.to_h
+    end
+
+    def explain(type)
+      @collectors.fetch(type).values
+    end
+
+    private
+
+    def collector_for(type)
+      @collectors[type] ||= ItemCollector.new
+    end
+
+    private_class_method :new
+  end
+end

data/lib/dataset_explorer/item_collector.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module DatasetExplorer
+  class ItemCollector
+    def initialize
+      @values = []
+    end
+
+    attr_reader :values
+
+    def add(item)
+      new_values = item.keys.map do |key|
+        map_keys(item[key], key)
+      end.flatten.map(&:to_s).uniq
+
+      @values << new_values
+      @values = @values.flatten.uniq
+    end
+
+    private
+
+    # rubocop:disable Metrics/MethodLength
+    def map_keys(value, key = nil, prefix = nil)
+      prefix = [prefix, key].compact.join('.')
+
+      unless mappable?(value)
+        return prefix
+      end
+
+      if behaves_like_hash?(value)
+        return value.keys.map do |sub_key|
+          map_keys(value[sub_key], sub_key, prefix)
+        end
+      end
+
+      if value.respond_to?(:each)
+        prefix = "#{prefix}.[]"
+        return [].tap do |values|
+          value.each do |item_value|
+            values << map_keys(item_value, nil, prefix)
+          end
+        end
+      end
+
+      raise Error, 'Unforseen scenario'
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def mappable?(value)
+      if behaves_like_hash?(value)
+        return true
+      end
+
+      if behaves_like_array?(value)
+        return true
+      end
+
+      false
+    end
+
+    def behaves_like_hash?(value)
+      value.respond_to?(:keys)
+    end
+
+    def behaves_like_array?(value)
+      value.respond_to?(:each)
+    end
+  end
+end

data/lib/dataset_explorer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DatasetExplorer
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: dataset_explorer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcelo Jacobus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-23 00:00:00.000000000 Z
+dependencies: []
+description: Explore and maps fields from a dataset - I.E. Api response
+email:
+- marcelo.jacobus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dataset_explorer.gemspec
+- lib/dataset_explorer.rb
+- lib/dataset_explorer/collector.rb
+- lib/dataset_explorer/item_collector.rb
+- lib/dataset_explorer/version.rb
+homepage: https://github.com/mjacobus/dataset_explorer
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mjacobus/dataset_explorer
+  source_code_uri: https://github.com/mjacobus/dataset_explorer
+  changelog_uri: https://github.com/mjacobus/dataset_explorer
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Explore and maps fields from a dataset - I.E. Api response
+test_files: []