fish0 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85525f8d2adf2b223e777689f28c07583ef03eca
+  data.tar.gz: 3ddae37272e67fb3b2a3f17601b140e3a768ed1d
+SHA512:
+  metadata.gz: 2d5d8251fc0e4cf34676ecd69b3b8dfc663790374c88b166493ab0d3e8337a1a080db943d09ec4ff0329c5334dd8ce93de4701a2d6f7bffa135aae30e9448a52
+  data.tar.gz: 35753e2406ce9b9065c4ebd30e8310d17b864df541866959cf6af8400e60cf31cdfc7498e6bcfdd9bcb7c6153e0e552aad2cf6bab974e5a12e9ff3197b41a45a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Dmitry Zuev
+
+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,137 @@
+# Fish0
+
+The fish doesn't think because the fish knows everything.
+
+Fish0 is the plugin for read-only content websites with MongoDB storage. Works perfect with Rambler&Co CQRS projects
+
+## Configuration
+
+```yml
+# config/mongo.yml
+
+development:
+  hosts:
+    - 'localhost:27017'
+  params:
+    :database: project_development
+
+production:
+  hosts:
+    - 'db.project.tld:27017'
+  params:
+    :database: project_production
+```
+
+## Repository
+
+### Basic repository usage
+
+This code will get first article with `slug: 'content123'` from `articles` MongoDB collection, and return content with class `Article`.
+
+```ruby
+Fish0::Repository.new(:articles)
+                 .where(slug: 'content123')
+                 .first!
+```
+
+By default Fish0::Repository will coerce `:entity_class` from `:collection`, so you can skip this parameter.
+
+### Writing your own repository
+
+```ruby
+# app/services/article_repository.rb
+class ArticleRepository < Fish0::Repository
+  def initialize
+    super(:articles)
+  end
+
+  def published
+    where(visible: true, published_at: { '$lt': DateTime.now })
+  end
+end
+
+# app/controllers/articles_controller.rb
+class ArticlesController < ApplicationController
+  # ...
+
+  def show
+    @article = ArticleRepository.new.where(slug: params[:slug]).first!
+  end
+
+  # ...
+end
+```
+
+## Pagination
+
+```ruby
+# app/controllers/articles_controller.rb
+class ArticlesController < ApplicationController
+  include Fish0::Concerns::Paginatable
+
+  def index
+    @articles = paginate(ArticleRepository.new.published)
+  end
+
+  # ...
+
+  protected
+
+  def per_page
+    31
+  end
+
+  # ...
+end
+```
+
+## ViewModel
+
+ViewModel concern wraps Virtus around your models. It also adds `#to_partial_path` and `#type` methods. Method `#to_partial_path` helps render your models via `render` helper.
+
+
+```ruby
+# app/models/article.rb
+class Article
+  include Fish0::Concerns::ViewModel
+
+  attribute :headline, String
+  attribute :slug, String
+  attribute :content, Array[Hash]
+  attribute :published_at, DateTime
+
+  # ...
+end
+```
+
+## Cacheable
+
+If you want your models to support `#cache_key` method and use Rails caching, you should include Fish0::Concerns::Cacheable to such models.
+
+Your model should respond to `:updated_at` with DateTime object.
+
+```ruby
+# app/models/article.rb
+class Article
+  # ...
+  include Fish0::Concerns::Cacheable
+
+  # ...
+end
+
+# app/controllers/articles_controller.rb
+class ArticlesController < ApplicationController
+  # ...
+
+  def show
+    @article = ArticleRepository.new.where(slug: params[:slug]).first!
+    if stale?(@article)
+      respond_to do |format|
+        format.html
+      end
+    end
+  end
+
+  # ...
+end
+```

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Fish0'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/fish0/concerns/cacheable.rb

@@ -0,0 +1,37 @@
+module Fish0
+  module Concerns
+    module Cacheable
+      extend ActiveSupport::Concern
+
+      included do
+        def cache_key(*timestamp_names)
+          case
+          when timestamp_names.any?
+            timestamp = max_updated_column_timestamp(timestamp_names)
+            timestamp = timestamp.utc.to_s(:nsec)
+            "#{self.class.to_s.tableize}/#{slug}-#{timestamp}"
+          when timestamp = max_updated_column_timestamp
+            timestamp = timestamp.utc.to_s(:nsec)
+            "#{self.class.to_s.tableize}/#{slug}-#{timestamp}"
+          else
+            "#{self.class.to_s.tableize}/#{slug}"
+          end
+        end
+
+        private
+
+        def timestamp_attributes_for_update
+          [:updated_at]
+        end
+
+        def max_updated_column_timestamp(timestamp_names = timestamp_attributes_for_update)
+          timestamp_names
+            .map { |attr| self[attr] }
+            .compact
+            .map(&:to_time)
+            .max
+        end
+      end
+    end
+  end
+end

data/lib/fish0/concerns/paginatable.rb

@@ -0,0 +1,25 @@
+module Fish0
+  module Concerns
+    module Paginatable
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :page
+
+        protected
+
+        def page
+          @page ||= (params[:page].to_i || 1)
+        end
+
+        def paginate(collection)
+          Fish0::Paginator.new(collection, page_number: page, per_page: per_page).all
+        end
+
+        def per_page
+          22
+        end
+      end
+    end
+  end
+end

data/lib/fish0/concerns/view_model.rb

@@ -0,0 +1,20 @@
+module Fish0
+  module Concerns
+    module ViewModel
+      extend ActiveSupport::Concern
+
+      included do
+        include Virtus::Model
+        attribute :type, String
+
+        def type
+          (super || '').demodulize.underscore
+        end
+
+        def to_partial_path
+          "#{type}"
+        end
+      end
+    end
+  end
+end

data/lib/fish0/paginator.rb

@@ -0,0 +1,37 @@
+module Fish0
+  class Paginator
+    include Enumerable
+    delegate :each, :all, :skip, :limit, :padding, to: :collection
+
+    attr_reader :collection
+
+    def initialize(collection, page_number: 1, per_page: 22, padding: 0)
+      @collection = collection || (fail ArgumentError)
+      @per = per_page
+      @page = page_number - 1
+      @padding = padding
+      per(per_page)
+      page(page_number)
+    end
+
+    def page(value = @page)
+      @page = value
+      skip(@page * @per + @padding)
+      self
+    end
+
+    def per(value = @per)
+      @per = value
+      skip(@page * @per + @padding)
+      limit(@per)
+      self
+    end
+
+    def padding(value)
+      @padding = value
+      page
+      skip
+      self
+    end
+  end
+end

data/lib/fish0/record_not_found.rb

@@ -0,0 +1,4 @@
+module Fish0
+  class RecordNotFound < StandardError
+  end
+end

data/lib/fish0/repository.rb

@@ -0,0 +1,90 @@
+module Fish0
+  class Repository
+    attr_reader :source,
+                :collection,
+                :conditions,
+                :order,
+                :skip_quantity,
+                :limit_quantity,
+                :entity_class
+
+    include Enumerable
+
+    delegate :find, to: :source
+    delegate :each, to: :all
+
+    def initialize(collection, entity_class = nil)
+      fail ArgumentError, "you should provide collection name" unless collection
+      @collection = collection
+      @source = Fish0.mongo_reader[collection]
+      @conditions = {}
+      @order = {}
+      @limit_quantity = 0
+      @skip_quantity = 0
+      @entity_class = entity_class || String(collection).singularize.camelize.constantize
+    end
+
+    def all
+      fetch.map(&to_entity)
+    end
+
+    def projection(values)
+      @projection = values
+      self
+    end
+
+    def first
+      element = fetch.limit(1).first
+      to_entity.call(element) if element
+    end
+
+    def first!
+      first || fail(RecordNotFound, "can't find in #{collection} with #{conditions}")
+    end
+
+    def where(query)
+      self.conditions.merge!(query)
+      self
+    end
+
+    def search(string)
+      where('$text' => { '$search' => string })
+      self
+    end
+
+    def order_by(query)
+      order.merge!(query)
+      self
+    end
+
+    def limit(value)
+      @limit_quantity = value
+      self
+    end
+
+    def skip(value)
+      @skip_quantity = value
+      self
+    end
+
+    def follow_after(item)
+      fail ArgumentError unless item.respond_to?(:published_at)
+
+      order_by(published_at: -1).where(published_at: { '$lt': item.published_at })
+    end
+
+    protected
+
+    def fetch
+      scoped = find(conditions, sort: order)
+      scoped = scoped.projection(@projection) if @projection
+      scoped = scoped.skip(skip_quantity) if skip_quantity > 0
+      scoped = scoped.limit(limit_quantity) if limit_quantity > 0
+      scoped
+    end
+
+    def to_entity
+      -> (attrs) { entity_class.new(attrs) }
+    end
+  end
+end

data/lib/fish0/version.rb

@@ -0,0 +1,3 @@
+module Fish0
+  VERSION = "0.0.1"
+end

data/lib/fish0.rb

@@ -0,0 +1,21 @@
+require 'mongo'
+require 'fish0/version'
+require 'fish0/record_not_found'
+require 'fish0/repository'
+require 'fish0/paginator'
+require 'fish0/concerns/cacheable'
+require 'fish0/concerns/paginatable'
+require 'fish0/concerns/view_model'
+
+module Fish0
+  class << self
+    def mongo_reader
+      Mongo::Logger.logger = mongo_config['logger'] || Rails.logger
+      Mongo::Client.new(mongo_config['hosts'], mongo_config['params'])
+    end
+
+    def mongo_config
+      @mongo_config || Rails.application.config_for(:mongo)
+    end
+  end
+end

data/lib/tasks/fish0_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :fish0 do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: fish0
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dmitry Zuev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+description: Plugin for read-only content websites with MongoDB storage. Works perfect
+  with Rambler&Co CQRS projects
+email:
+- d.zuev@rambler-co.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/fish0.rb
+- lib/fish0/concerns/cacheable.rb
+- lib/fish0/concerns/paginatable.rb
+- lib/fish0/concerns/view_model.rb
+- lib/fish0/paginator.rb
+- lib/fish0/record_not_found.rb
+- lib/fish0/repository.rb
+- lib/fish0/version.rb
+- lib/tasks/fish0_tasks.rake
+homepage: https://github.com/rambler-digital-solutions/fish0
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Plugin for read-only content websites
+test_files: []