ohm-scope 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47bf355b27124d30d8e908b38b136a6ca3bdb20c
+  data.tar.gz: 690faf13bc68a01e92797baeb1ef471404eb80a6
+SHA512:
+  metadata.gz: c664eccb72e07bb3216747ed10fdacc27123507f14a0af01a08e4500e65833a046722e0a07eca5b2a5220ecfa44adba52925469b368c00ba2badb0de51188368
+  data.tar.gz: a5bf96adecca02db629dddb969b1f5a4cac3edb3e20d29596e81665dbe7850477068aacc41e999e0c84cae1fb3d75c091113a82cf9b697347487494ad3ebc34c

data/.gems

@@ -0,0 +1,2 @@
+cutest -v 1.2.3
+ohm -v 3.1.1

data/.gitignore

@@ -0,0 +1,2 @@
+.gs/
+.DS_Store

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2017 Steven Weiss
+
+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/Makefile

@@ -0,0 +1,10 @@
+.PHONY: test
+
+install: .gems
+	gs dep install
+
+test:
+	gs cutest -r ./test/all.rb
+
+.gems:
+	mkdir -p .gs

data/README.md

@@ -0,0 +1,81 @@
+# Ohm::Scope
+
+Ohm::Scope wraps Ohm::Model to let you work with user
+input in a way that is both safe and familiar to Ohm users.
+
+## Installation
+
+`$ gem install ohm-scope`
+
+## Usage
+
+Ohm::Scope implements all of Ohm::Model's public class methods while maintaining
+the same contract as using Ohm::Model directly. If you're comfortable with Ohm::Model,
+you should feel at home using Ohm::Scope. The one method new to Ohm::Scope
+is the `#build` method. It is a factory method that delegates
+to the scope's model class `::new` method by default, but also lets us
+pass an argument for a different class if we want to construct something other
+than a model.
+
+### Example
+
+```ruby
+  require 'syro'
+  require 'ohm'
+  require 'ohm/scope'
+
+  class User < Ohm::Model
+    collection :posts, :Post
+  end
+
+  class Post < Ohm::Model
+    attribute :title
+
+    unique :title
+
+    reference :user, :User
+  end
+
+  class Deck < Syro::Deck
+    # A convenience helper for initializing scopes.
+    def scope(model, user)
+      Ohm::Scope.new(model, { user_id: user.id })
+    end
+
+    # A pretend authentication solution.
+    def curent_user
+      User.with(:auth_token, req.session[:auth_token])
+    end
+  end
+
+  App = Syro.new(Deck) do
+    on 'posts' do
+      # Create a new scope that will allow the `current_user` to
+      # have access to only their posts.
+      @posts = scope(Post, current_user)
+
+      post do
+        # With our `@posts` scope, we can safely create new records via request params.
+        # The params should probably still be validated for correctness,
+        # but the scope protects us from the params containing a `:user_id` field
+        # with an id other than that of the authenticated user.
+        res.json @posts.create(params)
+      end
+
+      on :id do
+        # Finders are also scoped. If the url param `:id` contains
+        # an id for a post that doesn't belong to the authenticated user,
+        # our scope will return nil as if it doesn't exist.
+        @post = @posts[inbox[:id]]
+
+        patch do
+          ...
+        end
+
+        delete do
+          ...
+        end
+      end
+    end
+  end
+ruby```

data/lib/ohm/scope.rb

@@ -0,0 +1,55 @@
+module Ohm
+  class Scope
+    VERSION = '0.1.0'.freeze
+
+    def initialize(model, dict)
+      @model, @dict = model, dict
+    end
+
+    def create(**attributes)
+      build(**attributes).save
+    end
+
+    def build(klass = model, **attributes)
+      klass.new(scoped(attributes))
+    end
+
+    def [](id)
+      all[id]
+    end
+
+    def fetch(ids)
+      all.fetch(ids.select { |id| exists?(id) })
+    end
+
+    def with(key, val)
+      instance = model.with(key, val)
+
+      if instance && exists?(instance.id)
+        instance
+      else
+        nil
+      end
+    end
+
+    def exists?(id)
+      !!all[id]
+    end
+
+    def all
+      find({})
+    end
+
+    def find(attributes)
+      model.find(scoped(attributes))
+    end
+
+    protected
+
+    attr_reader :model, :dict
+
+    def scoped(attributes = {})
+      attributes.merge(dict)
+    end
+  end
+end

data/ohm-scope.gemspec

@@ -0,0 +1,14 @@
+require './lib/ohm/scope'
+
+Gem::Specification.new do |s|
+  s.name     = 'ohm-scope'
+  s.summary  = 'Ohm::Scope'
+  s.version  = Ohm::Scope::VERSION
+  s.authors  = ['Steve Weiss']
+  s.email    = ['weissst@mail.gvsu.edu']
+  s.homepage = 'https://github.com/sirscriptalot/ohm-scope'
+  s.license  = 'MIT'
+  s.files    = `git ls-files`.split("\n")
+
+  s.add_dependency 'ohm', '~> 3.0'
+end

data/test/all.rb

@@ -0,0 +1,141 @@
+require          'ostruct'
+require          'ohm'
+require_relative '../lib/ohm/scope'
+
+class User < Ohm::Model
+  collection :posts, :Post
+end
+
+class Post < Ohm::Model
+  attribute :title
+  attribute :body
+
+  unique :title
+
+  index :body
+
+  reference :user, :User
+
+  collection :likes, :Like
+end
+
+prepare do
+  Ohm.flush
+end
+
+setup do
+  user = User.create
+
+  [Ohm::Scope.new(Post, user_id: user.id), user]
+end
+
+test '#create saves model with overridden attributes' do |posts, user|
+  title = 'overrides references'
+  post  = posts.create(title: title, user: User.create)
+
+  assert       post.id
+  assert_equal post.title, title
+  assert_equal post.user,    user
+  assert_equal post.user_id, user.id
+
+  title = 'overrides ids'
+  post  = posts.create(title: title, user_id: User.create.id)
+
+  assert       post.id
+  assert_equal post.title, title
+  assert_equal post.user,    user
+  assert_equal post.user_id, user.id
+end
+
+test '#build initializes a new instance of klass arg' do |posts, user|
+  klass = OpenStruct
+  title = 'in scope'
+  post  = posts.build(klass, title: title)
+
+  assert       !post.id
+  assert_equal post.class, klass
+  assert_equal post.title, title
+
+  post = posts.build(title: title) # klass should default to model
+
+  assert       !post.id
+  assert_equal post.class, Post
+  assert_equal post.title, title
+end
+
+test '#[] queries for single record by id in scope' do |posts, user|
+  post = posts.create(title: 'in scope')
+
+  assert_equal posts[post.id], post
+
+  post = Post.create(title: 'out of scope')
+
+  assert_equal posts[post.id], nil
+end
+
+test '#fetch queries for many records by id in scope' do |posts, user|
+  collection = []
+
+  2.times { |i| collection << posts.create(title: "in scope #{i}") }
+
+  assert_equal posts.fetch(collection.collect(&:id)), collection
+
+  collection << Post.create(title: 'out of scope')
+
+  assert posts.fetch(collection.collect(&:id)) != collection
+end
+
+test '#with queries single record by unique index in scope' do |posts, user|
+  title = 'in scope'
+  post  = posts.create(title: title)
+
+  assert_equal posts.with(:title, title), post
+
+  title = 'out of scope'
+  Post.create(title: title)
+
+  assert_equal posts.with(:title, title), nil
+end
+
+test '#with raises for non-unique index' do |posts, user|
+  assert_raise(Ohm::IndexNotFound) do
+    posts.with(:body, 'body')
+  end
+end
+
+test '#exists? checks if record with id exists in scope' do |posts, user|
+  post = posts.create(title: 'in scope')
+
+  assert posts.exists?(post.id)
+
+  post = Post.create(title: 'out of scope')
+
+  assert !posts.exists?(post.id)
+end
+
+test '#all returns all records in scope' do |posts, user|
+  2.times { |i| posts.create(title: "in scope #{i}") }
+
+  Post.create(title: 'out of scope')
+
+  assert posts.all.count > 0
+
+  posts.all.each do |post|
+    assert_equal post.user, user
+  end
+end
+
+test '#find queries for records by indexes in scope' do |posts, user|
+  body = 'correct body'
+
+  2.times { |i| posts.create(title: "in scope #{i}", body: body) }
+
+  posts.create(title: 'in scope wrong body', body: 'wrong')
+
+  Post.create(title: 'out of scope correct body', body: body)
+
+  posts.find(body: body).each do |post|
+    assert_equal post.body, body
+    assert_equal post.user, user
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: ohm-scope
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Weiss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ohm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- weissst@mail.gvsu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gems"
+- ".gitignore"
+- LICENSE
+- Makefile
+- README.md
+- lib/ohm/scope.rb
+- ohm-scope.gemspec
+- test/all.rb
+homepage: https://github.com/sirscriptalot/ohm-scope
+licenses:
+- MIT
+metadata: {}
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Ohm::Scope
+test_files: []