shrek 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1e94b489a95faebdcfb659d0d05cfff09f61c06db8a045879cab5069ec6e81b
-  data.tar.gz: 5322185041b996e16547cf01db847d45e9ba10acc8dee6c2765a2c5808e0c026
+  metadata.gz: '068de42c241b85ca45f4a3b3221c34e706789b5a73ac7b98734dc1d84610fec2'
+  data.tar.gz: 054b17a00cef2897177cfd0a1eda89a3a6adef6ef10b6f2fd58da1b4e4f65b52
 SHA512:
-  metadata.gz: 908cf284a79067aba046d1c9e078931ac9a7223d87605c1ea6753b5bf7be545225169fdff4865d6002f090ee0bba24f2c8287958374fc66b207b1988defd8d6a
-  data.tar.gz: f9257be0e9413dcd823caf44a4b4890b3801e147c98389dc3c94831742559a601c9d3b4a40fbdbe383b50f2f6d4f154892cfe0ae2da38a71e2a919ea33f66b73
+  metadata.gz: 94817e382d811bb64006470143a8f267c9aa91bf2fd1080c24b4c2e0d310c585b419b9b68430d827371e524ee5c51087e82495a7bc88d9fa7bd9685876283819
+  data.tar.gz: e492291ac0d33d772bfe61f8f2219f46643939a70ddecedf52b7ff03379f18861406431b4d6218913df68373acc3f369aad5768c473ce99f24bcd1aebdf5cf32

data/README.md

@@ -68,9 +68,13 @@ may be used in own classes
     include Shrek
   end
   
-  Paint.new.use_layers FindPaints, SelectWall, PrepareBrushes
+  Paint.new.use_layers FindPaints, SelectWall, PrepareBrushes,
+                       self_return: ->(result) { a }
 ```
 
+We also are able to make some tuning with returning value with `self_return` option.
+It use something, which respond_to :call.
+
 Let's summarize procs and cons of this concept:
 
 ##### Procs

data/examples/tree_pruning/.gitignore

@@ -0,0 +1,30 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore uploaded files in development
+/storage/*
+
+/node_modules
+/yarn-error.log
+
+/public/assets
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key

data/examples/tree_pruning/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/examples/tree_pruning/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_from: ../../.rubocop.yml
+
+Style/MixinUsage:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 20

data/examples/tree_pruning/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/examples/tree_pruning/Gemfile

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby '2.5.1'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 5.2.0'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+# Use Puma as the app server
+gem 'puma', '~> 3.11'
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 5.0'
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+# See https://github.com/rails/execjs#readme for more supported runtimes
+# gem 'mini_racer', platforms: :ruby
+
+# Use CoffeeScript for .coffee assets and views
+gem 'coffee-rails', '~> 4.2'
+# Turbolinks makes navigating your web application faster. Read more: https://github.com/turbolinks/turbolinks
+gem 'turbolinks', '~> 5'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.5'
+# Use Redis adapter to run Action Cable in production
+# gem 'redis', '~> 4.0'
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use ActiveStorage variant
+# gem 'mini_magick', '~> 4.8'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+# Reduces boot times through caching; required in config/boot.rb
+gem 'bootsnap', '>= 1.1.0', require: false
+
+gem 'ice_nine', '~> 0.11'
+gem 'shrek', '~> 0.2'
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platforms: %i[mri mingw x64_mingw]
+  gem 'pry-rails', '~> 0.3'
+  gem 'rspec-rails', '~> 3.7'
+end
+
+group :development do
+  # Access an interactive console on exception pages or by calling 'console' anywhere in the code.
+  gem 'listen', '>= 3.0.5', '< 3.2'
+  gem 'web-console', '>= 3.3.0'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+group :test do
+  # Adds support for Capybara system testing and selenium driver
+  gem 'capybara', '>= 2.15', '< 4.0'
+  gem 'selenium-webdriver'
+  # Easy installation and use of chromedriver to run system tests with Chrome
+  gem 'chromedriver-helper'
+  gem 'webmock', '~> 3.3'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]

data/examples/tree_pruning/README.md

@@ -0,0 +1,83 @@
+# The problem
+
+Imagine you have a tree of various Indicators that track something about a country's population. The client wants to display them, but only a few of them at a time.
+
+These Indicators are part of a tree, and they’re grouped by Themes, Sub-themes, and Categories. For example, we have an indicator called “Crude death rate”. It resides in the Category "Births per year", which lives inside the Sub-theme “Births and Deaths”, which in turn lives inside the Theme “Demographics”.
+
+This data comes from a client-provided service, which doesn’t support picking and choosing which things to filter. Because of valid reasons we won’t expound on here, it wouldn’t make sense to add this feature to the upstream service, and it’s on us to build an intermediary service that can do this.
+
+
+Because we don’t know how to program, this service explodes quite regularly. It’s expected that your solution should retry a few times in case of failure.
+
+You can find sample input data in the test suite
+
+## Solution
+
+You’re to make an API that has one single endpoint, /tree/<name>. It will receive the name of the upstream tree to request, as well as a list of values as GET params, indicator_ids[] to filter for. If you get asked to show an Indicator, you should return the subtree that reaches it. Here's an example URL:
+
+    http://127.0.0.1:5000/tree/input?indicator_ids[]=31&indicator_ids[]=32&indicator_ids[]=1
+
+Except for filtering out uninteresting Categories, Sub-themes and Themes, you must preserve all the other attributes in the nodes.
+
+## Potential edge cases
+
+After an earnest try to maintain service, if the upstream still doesn’t work, return a 500.
+If the tree you were asked for does not exist, return a 404.
+
+The upstream server has no schedule for changes. Don’t cache its answers.
+
+## Things that we’ll pay attention to
+
+* Code ergonomy (style and readability)
+* Testing strategy
+* Resilience to network/upstream problems
+* Separation of concerns and code structure
+
+## Visualization of a pruned tree
+
+In the tree below, when asked for the four indicators in bold (Urban, Male, Female, >30y), you should return a subtree containing only the highlighted nodes.
+
+| Theme              | Sub-Theme            | Category                 | Indicator       |
+|-------------       |----------------      |----------------          |-----------------|
+| `Urban`            | `Administrative`     | `Area`                   | Rural           |        
+| `Urban`            | `Administrative`     | `Area`                   | **Urban**       |        
+| `Urban`            | `Administrative`     | Population               | Total           |        
+| `Urban`            | `Administrative`     | Population               | Male            |        
+| `Urban`            | `Administrative`     | Population               | Female          |        
+| Jobs               | Labor force          | Working population       | Total           |        
+| Jobs               | Unemployment         | 15-24 years              | Male            |        
+| Jobs               | Unemployment         | 15-24 years              | Female          |        
+| `Demographics`     | `Birth and deaths`   | Deaths per year          | Natural         |        
+| `Demographics`     | `Birth and deaths`   | Deaths per year          | Accidents?      |        
+| `Demographics`     | `Birth and deaths`   | Deaths per year          | Murder          |        
+| `Demographics`     | `Birth and deaths`   | `Births per year`        | **Male**        |        
+| `Demographics`     | `Birth and deaths`   | `Births per year`        | **Female**      |        
+| `Demographics`     | `Age and sex`        | `Age distribution`       | < 3y            |
+| `Demographics`     | `Age and sex`        | `Age distribution`       | <18y            |
+| `Demographics`     | `Age and sex`        | `Age distribution`       | <30y            |
+| `Demographics`     | `Age and sex`        | `Age distribution`       | **>30y**        |
+| `Demographics`     | `Age and sex`        | Sex                      | Yes             |
+| `Demographics`     | `Age and sex`        | Sex                      | No              |
+
+
+The resulting (pruned) tree should be this:
+
+| Theme              | Sub-Theme            | Category                 | Indicator       |
+|-------------       |----------------      |----------------          |-----------------|
+| `Urban`            | `Administrative`     | `Area`                   | **Urban**       |   
+| `Demographics`     | `Birth and deaths`   | `Births per year`        | **Male**        |        
+| `Demographics`     | `Birth and deaths`   | `Births per year`        | **Female**      |  
+| `Demographics`     | `Age and sex`        | `Age distribution`       | **>30y**        |  
+
+# Result
+
+Finish endpoint can used with
+
+```
+curl -v 'http://127.0.0.1:3000/?indicator_ids\[\]=31&indicator_ids\[\]=32&indicator_ids\[\]=1'
+```
+
+In the real world will be good to move all exceptions handling to `ApplicationController`
+but now I think it is ok as it is.
+
+I still do not have real endpoint. Use stub file is not right, so I leaved stub uri. 

data/examples/tree_pruning/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/examples/tree_pruning/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/examples/tree_pruning/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, or any plugin's
+// vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require turbolinks
+//= require_tree .

data/examples/tree_pruning/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/examples/tree_pruning/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, or any plugin's
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/examples/tree_pruning/app/channels/application_cable/channel.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/examples/tree_pruning/app/channels/application_cable/connection.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/examples/tree_pruning/app/controllers/application_controller.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ApplicationController < ActionController::Base
+end

data/examples/tree_pruning/app/controllers/tree_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class TreeController < ApplicationController
+  def index
+    render StatisticsProcessor.new.call(permitted_params.to_h.symbolize_keys)
+  end
+
+  private
+
+  def permitted_params
+    params.permit(sub_theme_ids: [], categorie_ids: [], indicator_ids: [])
+  end
+end

data/examples/tree_pruning/app/helpers/application_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module ApplicationHelper
+end

data/examples/tree_pruning/app/jobs/application_job.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ApplicationJob < ActiveJob::Base
+end

data/examples/tree_pruning/app/lib/layers/external_fetcher.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'net/http'
+module Layers
+  class ExternalFetcher < Shrek::Layers
+    def call(uri: 'enter_real_uri_here.stub', path: '/', tries: 3, **options)
+      next_layer.call(response(uri, path), options)
+    rescue StandardError => e
+      tries -= 1
+      retry if tries.positive?
+      { json: e.message, status: :internal_server_error }
+    end
+
+    private
+
+    def response(uri, path)
+      Net::HTTP.get_response(uri, path).body
+      # open(Rails.root.join('spec', 'fixtures', 'files', 'people_stats.json')).read
+    end
+  end
+end

data/examples/tree_pruning/app/lib/layers/parser.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Layers
+  class Parser < Shrek::Layers
+    def call(body = '', **options)
+      next_layer.call JSON.parse(body), options
+    rescue JSON::ParserError => e
+      { json: e.message, status: :unprocessable_entity }
+    end
+  end
+end

data/examples/tree_pruning/app/lib/layers/selector.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Layers
+  module NestedHashFilter
+    refine Hash do
+      def fetch_for(wanted_key, wanted_ids)
+        fetch(wanted_key.to_s, []).delete_if do |wanted|
+          next if Array(wanted_ids).map(&:to_i).include? wanted.fetch('id') { raise JSON::ParserError }
+          block_given? ? yield(wanted) : true
+        end.empty?
+      end
+
+      def proceed(**args)
+        return fetch_for(*args.shift) if args.keys.one?
+        fetch_for(*args.shift) { |wrap| wrap.proceed(args) if args.any? }
+      end
+    end
+  end
+
+  using Layers::NestedHashFilter
+
+  class NotFound < StandardError; end
+
+  class Selector < Shrek::Layers
+    def call(data, sub_theme_ids: nil, categorie_ids: nil, indicator_ids: nil, **_options)
+      return { json: data } if Array(sub_theme_ids).empty? &&
+                               Array(categorie_ids).empty? &&
+                               Array(indicator_ids).empty? && data.any?
+
+      result = data.delete_if do |w|
+        w.proceed(sub_themes: sub_theme_ids, categories: categorie_ids, indicators: indicator_ids)
+      end
+
+      raise(NotFound) if result.empty?
+      { json: result }
+    rescue NotFound
+      not_found
+    end
+
+    private
+
+    def not_found
+      { json: '', status: :not_found }
+    end
+  end
+end

data/examples/tree_pruning/app/lib/statistics_processor.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class StatisticsProcessor
+  include Shrek
+
+  def call(*args)
+    use_layers(::Layers::ExternalFetcher, ::Layers::Parser, ::Layers::Selector).call(*args)
+  end
+end