data_guru 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3385e9759c76cf598810c880efcb0011dc62331e
-  data.tar.gz: 86cc6fe4ee3c388e111156b00e5d54f8e1674603
+  metadata.gz: cf330d25b127f1da2f00404a6f4ecf142138effe
+  data.tar.gz: 9ad2c100a458d829ef2eb8ead64699fa48017b1e
 SHA512:
-  metadata.gz: 1320b19b6d3f119730dcd173b31660754da2585490b758c7b9269c76a1c8d70300283f280b7e5b476188a361cc48efcf0d2331175467d745074fab99ac1cc363
-  data.tar.gz: 1d7a38793ecbe88a33eba71d70d954b7fed3b90bfe3d72ac5d9be0f51b796a26f1e83bfc3b57efe5f64a0abc43c41003dfa9530efbe13115210eed068f4cc134
+  metadata.gz: 218cd813a01bdda3951e8e6470450a292e913b6af31b1c805f711e089fcdba266f27656cf26de64ae6f71459afc7943fc1ac167b33021ada4354b1f1f58f968e
+  data.tar.gz: 9e0b53bb35dde722135124f95e7170f6e29a25228662cecf7965fea3ee8a995ab77c27236f9063fa081521255da0545de1d1560ed9c24a48cb84e3be9860f0d7

data/.rubocop.yml

@@ -1,4 +1,5 @@
 Metrics/LineLength:
+  Max: 100
   Exclude:
     - '*.gemspec'
 Documentation:

data/Guardfile

@@ -0,0 +1,12 @@
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, cmd: "bin/rspec" do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/data_guru/(.+)\.rb$}) { |m| "spec/data_guru/#{m[1]}_spec.rb" }
+    watch("spec/spec_helper.rb") { "spec" }
+  end
+
+  guard :rubocop, all_on_start: false, cli: ["--auto-correct"] do
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/README.md

@@ -87,18 +87,62 @@ member = data.members.all.first
 # to get list of member attributes
 member.attributes
 
-# to get list of permitted and required attributes (see Permisions section below)
+# to get list of permitted and required attributes (see Permissions section below)
 member.permitted_attributes
 member.required_attributes
 
-# check if member has all required attributes set
+# check if member has all required attributes set with valid datatypes
 member.valid?
 member.missing_attributes
+member.invalid_data_type_attributes
 ```
 
 Each model has a set of getter methods (`permitted_attributes`), so for example you can do `member.github` to get just the github membername.
 Each model also has `id` method which returns the name of the file the member is stored in, for example it will return `john.doe` for the member in the file `john.doe.yml`.
 
+To check if files in your Permissions repo contain valid information you can run:
+
+```ruby
+DataGuru::Client.new.invalid_values
+```
+
+You will get a hash with names of invalid files and values which are missing or have invalid datatype:
+
+```ruby
+# {
+#   "john.doe.yml" => {
+#     "missing_attributes" => [:emails, :external],
+#     "invalid_data_type_attributes" => [:github]
+#   }
+# }
+```
+
+You can also check invalid values of particular collection:
+
+```ruby
+DataGuru::Client.new.invalid_values("users")
+```
+
+If you want to check a particular value in a collection, you need to specify collection name and value name:
+
+```ruby
+DataGuru::Client.new.invalid_values("users", "email")
+
+```
+
+You will get an array containing names of files from "users" collection which have invalid "email" value:
+
+```ruby
+# ["john.doe.yml", "jane.foe.yml"]
+
+```
+
+You can also pass parameters as symbols:
+
+```ruby
+DataGuru::Client.new.invalid_values(:users, :email)
+```
+
 You can check whether configuration (in your rails app) and model configuration (in your permissions repo) is valid by running `DataGuru::Client.new.errors`.
 
 ### Permissions

data/bin/_guard-core

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "_guard-core")

data/bin/guard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "guard")

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/data_guru.gemspec

@@ -27,4 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-rubocop"
 end

data/lib/data_guru.rb

@@ -9,6 +9,8 @@ require "data_guru/validations/model_configuration"
 require "data_guru/collection"
 require "data_guru/model"
 require "data_guru/client"
+require "data_guru/invalid_values"
+require "data_guru/exceptions"
 
 module DataGuru
   class << self

data/lib/data_guru/client.rb

@@ -1,18 +1,18 @@
 module DataGuru
   class Client
-    require 'httparty'
-    require 'active_support/core_ext/string'
+    require "httparty"
+    require "active_support/core_ext/string"
 
     def initialize(api_url: nil, access_token: nil)
-      if api_url.present? && access_token.present?
-        DataGuru.config = Configuration.new(api_url: api_url,
-                                            access_token: access_token)
-      end
+      return if api_url.blank? || access_token.blank?
+      DataGuru.config = Configuration.new(api_url: api_url, access_token: access_token)
     end
 
     def method_missing(name)
       create_model_class(name) if should_create_class?(name)
-      value = DataGuru::Collection.new(collection_name: name, model: model(name))
+      value = DataGuru::Collection.new(collection_name: name,
+                                       model: model(name),
+                                       config_data: config_data[config_key(name)])
       get_variable(name) || set_variable(name, value)
     end
 
@@ -25,6 +25,14 @@ module DataGuru
       DataGuru::Validation.new.errors
     end
 
+    def invalid_values(collection = "", attribute = "")
+      DataGuru::InvalidValues.new(self, collection, attribute).call
+    end
+
+    def config_data
+      @config_data ||= HTTParty.get(config_resource_url)
+    end
+
     private
 
     def should_create_class?(name)
@@ -64,6 +72,7 @@ module DataGuru
     def wipe_collections_cache
       collection_names.each { |name| instance_variable_set("@#{name}", nil) }
       instance_variable_set("@collection_names", nil)
+      instance_variable_set("@config_data", nil)
     end
 
     def refresh_data_url
@@ -77,5 +86,13 @@ module DataGuru
     def collection_names_url
       "#{DataGuru.config.api_url}/?token=#{DataGuru.config.access_token}"
     end
+
+    def config_resource_url
+      "#{DataGuru.config.api_url}/collections/config?token=#{DataGuru.config.access_token}"
+    end
+
+    def config_key(name)
+      name.to_s.singularize
+    end
   end
 end

data/lib/data_guru/collection.rb

@@ -1,14 +1,15 @@
 module DataGuru
   class Collection
     include Enumerable
-    require 'httparty'
+    require "httparty"
 
-    attr_reader :collection_name, :model, :config
+    attr_reader :collection_name, :model, :config_data, :config
 
-    def initialize(collection_name:, model:, config: default_config(model))
+    def initialize(collection_name:, model:, config_data:, config: default_config(model, config_data))
       @collection_name = collection_name
       @model = model
       @config = config
+      @config_data = config_data
     end
 
     def all
@@ -21,8 +22,8 @@ module DataGuru
 
     private
 
-    def default_config(model)
-      DataGuru::ModelConfiguration.new(model: model)
+    def default_config(model, config_data)
+      DataGuru::ModelConfiguration.new(model: model, config_data: config_data)
     end
 
     def build_models(collection_type)
@@ -36,14 +37,6 @@ module DataGuru
         "?token=#{DataGuru.config.access_token}"
     end
 
-    def config_resource_url
-      "#{DataGuru.config.api_url}/collections/config?token=#{DataGuru.config.access_token}"
-    end
-
-    def config_data
-      @config_data ||= HTTParty.get(config_resource_url)
-    end
-
     def data(collection_type)
       HTTParty.get(collection_resource_url(collection_type))
     end

data/lib/data_guru/exceptions.rb

@@ -0,0 +1,14 @@
+module DataGuru
+  class MissingValue < StandardError
+    attr_reader :attribute, :collection_name
+
+    def initialize(attribute, collection_name)
+      @attribute = attribute
+      @collection_name = collection_name
+    end
+
+    def message
+      "Value '#{attribute}' does not exist for '#{collection_name}' collection"
+    end
+  end
+end

data/lib/data_guru/invalid_values.rb

@@ -0,0 +1,49 @@
+module DataGuru
+  class InvalidValues
+    attr_reader :data, :collection_name, :attribute, :invalid_files
+
+    TYPES = %w(missing_attributes invalid_data_type_attributes)
+
+    def initialize(data, collection_name, attribute)
+      @data = data
+      @collection_name = collection_name
+      @attribute = attribute
+      @invalid_files = []
+    end
+
+    def call
+      collection_names.each { |collection_name| get_invalid_files(collection_name) }
+      invalid_values = invalid_files.each_with_object({}) do |file, h|
+        h["#{file.id}.yml"] = get_invalid_values(file)
+      end
+      attribute.present? ? files_with_invalid_attribute(attribute, invalid_values) : invalid_values
+    end
+
+    private
+
+    def get_invalid_values(file)
+      TYPES.each_with_object({}) do |type, h|
+        h[type] = file.send(type) unless file.send(type).empty?
+      end
+    end
+
+    def get_invalid_files(collection_name)
+      data.send(collection_name).each do |file|
+        invalid_files << file unless file.valid?
+      end
+    end
+
+    def collection_names
+      collection_name.present? ? [collection_name] : data.send(:collection_names) - ["config"]
+    end
+
+    def files_with_invalid_attribute(attribute, h)
+      fail DataGuru::MissingValue.new(attribute, collection_name).message unless value_exists?
+      h.map { |k, v| k if v.to_s.include?(attribute.to_s) }.compact
+    end
+
+    def value_exists?
+      data.send(collection_name).config_data.keys.include? attribute.to_s
+    end
+  end
+end

data/lib/data_guru/model.rb

@@ -1,15 +1,16 @@
 module DataGuru
   module Model
-    attr_reader :permitted_attributes, :required_attributes, :id
+    attr_reader :permitted_attributes, :required_attributes, :data_types, :id
 
     def initialize(key, attrs, config, config_data)
       @id = key
-      @permitted_attributes = config.permitted_attributes(config_data)
-      @required_attributes = config.required_attributes(config_data)
+      @permitted_attributes = config.permitted_attributes
+      @required_attributes = config.required_attributes
+      @data_types = config.data_types
 
       permitted_attributes.each do |attribute|
         set_attr_getter(attribute)
-        default_value = config.attributes(config_data)[attribute.to_s]["default_value"]
+        default_value = config_data[attribute.to_s]["default_value"]
         set_attr_value(attribute, attrs[attribute.to_s], default_value)
       end
     end
@@ -19,19 +20,29 @@ module DataGuru
     end
 
     def valid?
-      present_required_attributes == required_attributes
+      missing_attributes.empty? && invalid_data_type_attributes.empty?
     end
 
     def missing_attributes
       required_attributes - present_required_attributes
     end
 
+    def invalid_data_type_attributes
+      data_types.map do |name, value|
+        next if attributes[name].nil?
+        if value == "boolean"
+          name unless [true, false].include? attributes[name]
+        else
+          name unless attributes[name].class == value.classify.constantize
+        end
+      end
+        .compact
+    end
+
     private
 
     def set_attr_getter(attribute)
-      self.class.send(:define_method, attribute) do
-        instance_variable_get("@#{attribute}")
-      end
+      self.class.send(:define_method, attribute) { instance_variable_get("@#{attribute}") }
     end
 
     def set_attr_value(attribute, value, default_value)
@@ -40,15 +51,11 @@ module DataGuru
     end
 
     def present_required_attributes
-      required_attributes.map do |name|
-        !attributes[name].nil? ? name : nil
-      end
+      required_attributes.map { |name| attributes[name].present? ? name : nil }
     end
 
     def all_attributes
-      attrs = permitted_attributes
-        .map{ |name| [name, public_send(name)] } << [:id, id]
-      Hash[attrs]
+      permitted_attributes.each_with_object({ id: id }) { |name, h| h[name] = public_send(name) }
     end
   end
 end

data/lib/data_guru/model_configuration.rb

@@ -1,32 +1,22 @@
 module DataGuru
   class ModelConfiguration
-    attr_reader :model, :model_name
+    attr_reader :model, :config_data
 
-    def initialize(model:, model_name: default_model_name(model))
+    def initialize(model:, config_data:)
       @model = model
-      @model_name = model_name
+      @config_data = config_data.try(:symbolize_keys)
     end
 
-    def attributes(config_data)
-      config_data[model_name]
+    def permitted_attributes
+      config_data.keys
     end
 
-    def permitted_attributes(config_data)
-      attributes(config_data).map{ |k, _v| k.to_sym }
+    def required_attributes
+      config_data.select{ |_k,v| v['required'] }.keys
     end
 
-    def required_attributes(config_data)
-      attributes(config_data).map{ |k, v| v["required"] ? k.to_sym : nil }.reject(&:nil?)
-    end
-
-    private
-
-    def default_model_name(model)
-      model.name.split('::').last
-        .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-        .gsub(/([a-z\d])([A-Z])/,'\1_\2')
-        .tr("-", "_")
-        .downcase
+    def data_types
+      config_data.each_with_object({}) { |(k, v), h| h[k] = v["value_type"] }
     end
   end
 end

data/lib/data_guru/validation.rb

@@ -1,6 +1,6 @@
 module DataGuru
   class Validation
-    require 'httparty'
+    require "httparty"
     attr_reader :config, :keys
 
     TYPES = %w(configuration model_configuration)
@@ -11,7 +11,7 @@ module DataGuru
     end
 
     def errors
-      TYPES.flat_map{ |type| send("#{type}_errors") }
+      TYPES.flat_map { |type| send("#{type}_errors") }
     end
 
     private

data/lib/data_guru/validations/configuration.rb

@@ -27,11 +27,11 @@ module DataGuru
     end
 
     def api_url_error
-      'Configuration: no api url'
+      "Configuration: no api url"
     end
 
     def access_token_error
-      'Configuration: no access token'
+      "Configuration: no access token"
     end
   end
 end

data/lib/data_guru/validations/model_configuration.rb

@@ -3,9 +3,9 @@ module DataGuru
     attr_reader :config, :keys
 
     VALIDATIONS = %w(config model_file model_attributes model_attribute_name
-      model_attribute_content)
+                     model_attribute_content)
     RESERVED_WORDS = %w(id attributes permitted_attributes required_attributes
-      missing_attributes valid?)
+                        missing_attributes valid?)
     ATTRIBUTE_TYPES = %w(required default_value value_type)
 
     def initialize(config, keys)
@@ -21,7 +21,7 @@ module DataGuru
     private
 
     def model_names
-      keys.map(&:singularize) - ['config']
+      keys.map(&:singularize) - ["config"]
     end
 
     def valid?
@@ -36,41 +36,35 @@ module DataGuru
     end
 
     def config_valid?
-      keys.include?('config')
+      keys.include?("config")
     end
 
     def model_file_valid?
       return false unless config_valid?
-      valid_files = model_names
-        .map{ |name| config.include?(name) }
-        .select{ |name| name }
-      valid_files.size == model_names.size
+      model_names.count { |name| config.include?(name) } == model_names.size
     end
 
     def model_attributes_valid?
       return false unless model_file_valid?
-      valid_models = model_names
-        .map{ |name| config[name] == false || config[name].nil? }
-        .select{ |name| !name }
-      valid_models.size == model_names.size
+      model_names.count { |name| config[name] == false || config[name].nil? } == model_names.size
     end
 
     def model_attribute_name_valid?
-      attributes = present_models.flat_map{ |model| config[model].keys }
+      attributes = present_models.flat_map { |model| config[model].keys }
       diff = attributes - RESERVED_WORDS
       attributes.count == diff.count
     end
 
     def model_attribute_content_valid?
-      attributes = present_models.map{ |model| config[model] }
-      invalid_attrs = attributes.flat_map{ |model|
-          model.values.map{ |attributes| attributes.keys.sort == ATTRIBUTE_TYPES.sort }
-        }.select{ |a| !a }
+      attributes = present_models.map { |model| config[model] }
+      invalid_attrs = attributes.flat_map do |model|
+        model.values.map { |attrs| attrs.keys.sort == ATTRIBUTE_TYPES.sort }
+      end.select(&:!)
       invalid_attrs.size == 0
     end
 
     def config_error
-      'Model Configuration: no config directory in repo'
+      "Model Configuration: no config directory in repo"
     end
 
     def model_file_error
@@ -78,12 +72,14 @@ module DataGuru
     end
 
     def model_attributes_error
-      "Model Configuration: no permitted attributes for model - #{missing_model_contents.join(', ')}"
+      "Model Configuration: no permitted attributes for model - " \
+      "#{missing_model_contents.join(', ')}"
     end
 
     def model_attribute_name_error
       reserved_model_attributes.map do |model, attrs|
-        "Model Configuration: reserved words used as attributes in model #{model} - #{attrs.join(', ')}"
+        "Model Configuration: reserved words used as attributes in model #{model} - " \
+        "#{attrs.join(', ')}"
       end
     end
 
@@ -98,7 +94,7 @@ module DataGuru
 
     def missing_models
       return model_names unless config_valid?
-      model_names.flat_map{ |name| config.include?(name) ? [] : name }
+      model_names.flat_map { |name| config.include?(name) ? [] : name }
     end
 
     def missing_model_contents
@@ -117,23 +113,22 @@ module DataGuru
     end
 
     def reserved_model_attributes
-      wrong_attributes = present_models.map do |model|
-        wrong_attrs = config[model].keys & RESERVED_WORDS
-        [ model, wrong_attrs ]
-      end
-      Hash[wrong_attributes]
+      present_models.each_with_object({}) { |name, h| h[name] = config[name].keys & RESERVED_WORDS }
     end
 
     def missing_model_attributes
-      all = Hash[present_models.map{ |model| [model, config[model]] }]
+      all = present_models.each_with_object({}) { |model, h| h[model] = config[model] }
       missing = all.map do |model, attributes|
-          attrs = Hash[ attributes.map{ |name, types| [name, ATTRIBUTE_TYPES - types.keys] } ]
-          without_empty = attrs
-            .map{ |name, types| types.empty? ? [] : [name, types] }
-            .reject{ |array| array.empty? }
-          [ model, Hash[without_empty] ]
+        attrs = attributes.each_with_object({}) do |(name, types), h|
+          h[name] = ATTRIBUTE_TYPES - types.keys
+        end
+        without_empty = attrs.each_with_object({}) do |(name, types), h|
+          h[name] = types unless types.empty?
         end
-      Hash[missing.reject{ |k, v| v.empty? }]
+        [model, without_empty]
+      end
+      missing.each_with_object({}) { |(model, without_empty), h| h[model] = without_empty }
+        .reject { |_k, v| v.empty? }
     end
   end
 end

data/lib/data_guru/version.rb

@@ -1,3 +1,3 @@
 module DataGuru
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data_guru
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Adam Nowak
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-08 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -138,6 +138,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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: guard-rubocop
+  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: 
 email:
 - adam.nowak@netguru.co
@@ -151,9 +179,14 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - Gemfile
+- Guardfile
 - README.md
 - Rakefile
+- bin/_guard-core
 - bin/console
+- bin/guard
+- bin/rspec
+- bin/rubocop
 - bin/setup
 - circle.yml
 - data_guru.gemspec
@@ -161,6 +194,8 @@ files:
 - lib/data_guru/client.rb
 - lib/data_guru/collection.rb
 - lib/data_guru/configuration.rb
+- lib/data_guru/exceptions.rb
+- lib/data_guru/invalid_values.rb
 - lib/data_guru/model.rb
 - lib/data_guru/model_configuration.rb
 - lib/data_guru/validation.rb