daimon-exhibition 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d02e0c85807af9e362c83dd68d613aabc8dae5c5
+  data.tar.gz: b0b085d743e45881ca8e05ee8b5f781c264bab98
+SHA512:
+  metadata.gz: a94d38b0b738f5ec591f345a8ec7cf0b10537446d854f6de1f66bf8a506de812f932b549b2d1308373171713d64952d4792a45b8b0adeec41cadcf09800e6f43
+  data.tar.gz: a16ddae5cc8ea860f55896296877e33c0289ee4c10ff4d0349e50dda49df639a941ad7f00583e62a2f7829bff4fa8758794a326a67c01fe69479217c068d30f1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Ryunosuke Sato
+
+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,30 @@
+# Daimon::Exhibition
+
+A simple mylist that can contain some products.
+
+## Usage
+
+TODO: Write later.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'daimon-exhibition'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install daimon-exhibition
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,30 @@
+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    = 'Daimon::Exhibition'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task default: :spec

data/app/assets/config/daimon_exhibition_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/daimon/exhibition .js
+//= link_directory ../stylesheets/daimon/exhibition .css

data/app/assets/javascripts/daimon/exhibition/application.js

@@ -0,0 +1,13 @@
+// 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, vendor/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_tree .

data/app/assets/stylesheets/daimon/exhibition/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, vendor/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/app/controllers/concerns/daimon/exhibition/mylist_support.rb

@@ -0,0 +1,132 @@
+module Daimon
+  module Exhibition
+    module MylistSupport
+      def acts_as_mylist(exhibit_type, exhibit_scope)
+        include MylistController
+
+        enable_to_read_mylist
+        enable_to_write_mylist
+
+        define_method :exhibit_type do
+          exhibit_type
+        end
+
+        define_method :exhibit_scope, &exhibit_scope
+      end
+
+      def enable_to_read_mylist
+        include MylistReadable
+
+        helper_method :mylist
+      end
+
+      def enable_to_write_mylist
+        include MylistWritable
+
+        after_action :store_mylist, only: %i(create destroy destroy_all)
+
+        enable_to_read_mylist
+      end
+
+      module MylistReadable
+        protected
+
+        def mylist
+          @mylist ||= restore_mylist
+        end
+
+        private
+
+        def restore_mylist
+          ::Daimon::Exhibition::Mylist.load_from_serialized(session[:mylist])
+        end
+      end
+
+      module MylistWritable
+        include MylistReadable
+
+        private
+
+        def store_mylist
+          session[:mylist] = mylist.serialize
+        end
+      end
+
+      module MylistController
+        include MylistReadable
+        include MylistWritable
+
+        def index
+          @exhibits = exhibit_scope.merge(mylist.exhibits_of(exhibit_type))
+
+          assign_exhibits_variable @exhibits
+          assign_inquiry_variable @exhibits if has_inquiry?
+
+          respond_to do |format|
+            format.html
+            format.json { render_mylist_as_json }
+          end
+        end
+
+        def create
+          item = exhibit_scope.find(params[:id])
+
+          mylist.add item
+
+          respond_to do |format|
+            format.html { redirect_back fallback_location: item }
+            format.json { render_mylist_as_json status: :created }
+          end
+        end
+
+        def destroy
+          item = exhibit_scope.find_by(id: params[:id])
+
+          mylist.delete item if item
+
+          respond_to do |format|
+            format.html { redirect_back fallback_location: item }
+            format.json { render_mylist_as_json }
+          end
+        end
+
+        def destroy_all
+          mylist.clear(exhibit_type)
+
+          respond_to do |format|
+            format.html { redirect_back fallback_location: :root }
+            format.json { render_mylist_as_json }
+          end
+        end
+
+        private
+
+        def inquiry_class
+          ::Daimon::Exhibition::Mapping.detect_inquiry_by(exhibit_type)
+        end
+
+        def inquiry_type
+          ::Daimon::Exhibition::Mapping.detect_inquiry_type_by(exhibit_type)
+        end
+
+        def has_inquiry?
+          inquiry_class.present?
+        end
+
+        def assign_exhibits_variable(exhibits)
+          instance_variable_set "@#{exhibits.model_name.collection}", exhibits
+        end
+
+        def assign_inquiry_variable(exhibits)
+          @inquiry = inquiry_class.new(inquiry_class.exhibit_writer_for(exhibit_type) => exhibits.ids)
+
+          instance_variable_set "@#{inquiry_type}", @inquiry
+        end
+
+        def render_mylist_as_json(options = {})
+          render options.merge(json: mylist.ids_by_type(exhibit_type))
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/daimon/exhibition/exhibit.rb

@@ -0,0 +1,20 @@
+module Daimon
+  module Exhibition
+    module Exhibit
+      def acts_as_exhibit(to: :inquiry)
+        define_method "#{to}_params" do
+          {__send__("#{to}_key") => [__send__(self.class.primary_key)]}
+        end
+
+        define_method "#{to}_key" do
+          inquiry_class = ::Daimon::Exhibition::Mapping.detect_inquiry_by(self.class)
+          type          = ::Daimon::Exhibition::Mapping.class_to_type(self.class)
+
+          inquiry_class.exhibit_writer_for(type)
+        end
+
+        ::Daimon::Exhibition::Mapping.register(self, to)
+      end
+    end
+  end
+end

data/app/models/concerns/daimon/exhibition/inquiry.rb

@@ -0,0 +1,24 @@
+module Daimon
+  module Exhibition
+    module Inquiry
+      def acts_as_inquiry(to: , via: nil)
+        extend Writier
+
+        via ||= "#{to}_ids"
+        exhibits_writers[to] = via.to_sym
+      end
+
+      module Writier
+        def exhibit_writer_for(type)
+          exhibits_writers[type]
+        end
+
+        private
+
+        def exhibits_writers
+          @exhibits_writers ||= {}
+        end
+      end
+    end
+  end
+end

data/app/models/daimon/exhibition/mapping.rb

@@ -0,0 +1,56 @@
+module Daimon
+  module Exhibition
+    module Mapping
+      class << self
+        def register(klass, inquiry_type)
+          mapping[klass] = inquiry_type
+        end
+
+        def detect_inquiry_by(type)
+          inquiry_type = detect_inquiry_type_by(type)
+
+          type_to_class(inquiry_type)
+        end
+
+        def detect_inquiry_type_by(type)
+          klass =
+            case type
+            when Symbol
+              type_to_class(type)
+            when Class
+              type
+            else
+              nil
+            end
+
+          raise "The exhibit class `#{type}` is missing." unless klass
+
+          inquiry_type = mapping[klass]
+          raise "The inquiry class for `#{type.inspect}` is missing. The registered exhibit types are: (#{mapping.keys.join(', ')})" unless inquiry_type
+
+          inquiry_type
+        end
+
+        def detect_exhibits_by(type)
+          raise "Unregistered exhibit type: `#{type.inspect}`. The registered exhibit types are: (#{mapping.keys.join(', ')})" unless mapping.keys.any? {|klass| klass.model_name.param_key == type.to_s }
+
+          type_to_class(type)
+        end
+
+        def class_to_type(klass)
+          klass.model_name.param_key.to_sym
+        end
+
+        def type_to_class(type)
+          type.to_s.classify.safe_constantize
+        end
+
+        private
+
+        def mapping
+          @mapping ||= {}
+        end
+      end
+    end
+  end
+end

data/app/models/daimon/exhibition/mylist.rb

@@ -0,0 +1,80 @@
+module Daimon
+  module Exhibition
+    # TODO Depends on `primary_key`, not an `id`.
+
+    class Mylist
+      class << self
+        def load_from_serialized(serialized)
+          new(serialized)
+        end
+      end
+
+      def initialize(ids = nil)
+        @ids = (ids || {}).with_indifferent_access
+      end
+
+      def serialize
+        @ids.dup
+      end
+
+      def ids_by_type(type = nil)
+        if type
+          # To keep key for type.
+          {type => []}.with_indifferent_access.merge(@ids.deep_dup)
+        else
+          @ids.deep_dup
+        end
+      end
+
+      def count_of(type)
+        @ids[type].count
+      end
+
+      def count
+        @ids.values.flatten.count
+      end
+
+      def has_item?(type = nil)
+        (type ? count_of(type) : count) > 0
+      end
+
+      def empty?
+        !has_item?
+      end
+
+      def exhibits_of(type)
+        Mapping.detect_exhibits_by(type).where(id: @ids[type])
+      end
+
+      def include?(item)
+        ids_for(item).include?(item.id)
+      end
+
+      def add(item)
+        ids_for(item).push(item.id) unless include?(item)
+      end
+
+      def delete(item)
+        ids_for(item).delete(item.id)
+      end
+
+      def clear(type = nil)
+        if type
+          @ids[type]&.clear
+        else
+          @ids.clear
+        end
+      end
+
+      private
+
+      def ids_for(item)
+        @ids[type_of(item)] ||= []
+      end
+
+      def type_of(item)
+        Mapping.class_to_type(item.class)
+      end
+    end
+  end
+end