hanami-mongoid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7162e16b03ff0cd75aeeefabbd277145233ce4490cf69b906aec430ee8752154
+  data.tar.gz: 4f6ec29482d86fcf070476e727a0ebada89708f082cdd5a5a20e4a6bbb9a736c
+SHA512:
+  metadata.gz: 4dc1b5d3274d3a25f44838f865d1636df5a590f9e7cdaefc1f845d6dbc5c4c3db7e71075618ea1710ac442b5b1e120558e7cb02b52440c8ccae6b6115e2f64d2
+  data.tar.gz: 4ce0c86c9760f7589a16ff9fe5d4ab5b12fa0dae5bdff77ec5b214715e781ae5337eebb8e55924fa5c35c6fb363d2dc4251109b50e01067d565ae7138a5e4208

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hanami-mongoid.gemspec
+gemspec

data/README.md

@@ -0,0 +1,71 @@
+# Hanami::Mongoid
+
+This simple gem aims to replicate Hanami concept of _repositories_ when using MongoDB as database.
+It adds a class `Hanami::Mongoid::Repository` which is a substitute for the original `Hanami::Repository` class.
+
+## Installation
+
+Use thi line to your application's Gemfile instead of `hanami-model`:
+
+```ruby
+gem 'hanami-mongoid'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+When generating a new model, i.e. with
+
+    $ hanami generate model book
+
+Simpy delete the `db` folder (since MongoDB doesn't care for migrations) and change the following generated files:
+
+```ruby
+# lib/bookshelf/entities/book.rb
+class Book < Hanami::Entity
+end
+```
+```ruby
+# lib/bookshelf/entities/book.rb
+class Book
+    include Mongoid::Document
+end
+```
+
+And:
+
+```ruby
+# lib/bookshelf/repositories/book_repository.rb
+class BookRepository < Hanami::Repository
+end
+```
+```ruby
+# lib/bookshelf/repositories/book_repository.rb
+class BookRepository < Hanami::Mongoid::Repository
+end
+```
+
+This way you can keep separated the repository and entity logic as Hanami suggests.
+You can call the usual database related methods using the repository:
+```ruby
+BookRepository.first                        # #<Book:0x00007fd8b6bea578>
+BookRepository.find('5af4c697699bbdaad')    # #<Book id: 5af4c697699bbdaad>
+```
+Or even collection specific methods, for example `insert_many` or `aggregate`.
+
+And of course you can add custom queries in the repository:
+```ruby
+# lib/bookshelf/repositories/book_repository.rb
+class BookRepository < Hanami::Mongoid::Repository
+    def most_recent_for_author(author, limit = 8)
+        self.where(author: author).order_by(created_at: :desc).limit(limit)
+    end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Pluvie/hanami-mongoid.

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 "hanami/mongoid"
+
+# 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/hanami-mongoid.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hanami/mongoid/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hanami-mongoid"
+  spec.version       = Hanami::Mongoid::VERSION
+  spec.authors       = ["Francesco Ballardin"]
+  spec.email         = ["francesco.ballardin@develonproject.com"]
+
+  spec.summary       = %q{Adds repositories and wraps Mongoid methods for Hanami.}
+  spec.description   = %q{Adds repositories and wraps Mongoid methods for Hanami.}
+  spec.homepage      = "https://github.com/Pluvie/hanami-mongoid"
+
+  # 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('..', __FILE__)) 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"]
+
+  spec.add_dependency "mongoid"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/hanami/mongoid.rb

@@ -0,0 +1,10 @@
+require "hanami/mongoid/version"
+require "hanami/mongoid/repository"
+
+module Hanami
+  module Mongoid
+    class Error < StandardError; end
+
+    require "mongoid"
+  end
+end

data/lib/hanami/mongoid/repository.rb

@@ -0,0 +1,41 @@
+module Hanami
+  module Mongoid
+    class Repository
+
+      ##
+      # Model class
+      #
+      # @return [Class] the model class
+      def self.model_klass
+        Object.const_get self.name.gsub('Repository', '')
+      end
+
+      ##
+      # Forwards common repository methods to the model's class
+      %i( find where any_of all first last
+          new create update_all destroy_all delete_all ).each do |method|
+        define_singleton_method method do |*args|
+          puts self.inspect
+          self.model_klass.send method, *args
+        end
+      end
+
+      ##
+      # Forwards common repository methods to the model's instance
+      %i( update_attributes update destroy delete ).each do |method|
+        define_method method do |*args|
+          self.send method, *args
+        end
+      end
+
+      ##
+      # Forwards common repository methods to the model's collection
+      %i( insert_many aggregate ).each do |method|
+        define_singleton_method method do |*args|
+          self.model_klass.collection.send method, *args
+        end
+      end
+
+    end
+  end
+end

data/lib/hanami/mongoid/version.rb

@@ -0,0 +1,5 @@
+module Hanami
+  module Mongoid
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: hanami-mongoid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Francesco Ballardin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Adds repositories and wraps Mongoid methods for Hanami.
+email:
+- francesco.ballardin@develonproject.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hanami-mongoid.gemspec
+- lib/hanami/mongoid.rb
+- lib/hanami/mongoid/repository.rb
+- lib/hanami/mongoid/version.rb
+homepage: https://github.com/Pluvie/hanami-mongoid
+licenses: []
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Adds repositories and wraps Mongoid methods for Hanami.
+test_files: []