ecm_calendar_helper 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3e5f21214725193d52d1c15380ed1c03c04b8e6
-  data.tar.gz: 15278f09109d889796d8c3f91eddf1628230c0b9
+  metadata.gz: 8464ada0852fc7dd950d6325a45f6af8f32feb7a
+  data.tar.gz: cbebb41ffb1b5fa22ce730a1b2bafb47bf6c5e4a
 SHA512:
-  metadata.gz: 8a05e3299d4059ab13376b008a7b8f1745cb7406c541ef4ceec4f4012c3eec063a22e90a07f2844ab90d82329bed3e645df8bd239a84346bc9c6a39f0f7fe659
-  data.tar.gz: ac222cd53b256fea99960dc1562aa81e9b1797824dacafdeb7c695474aeae3da6b60e4c4cd0a1bbd5ee7bbcc286ec8dbd38d565d9d3bcffa5630a8f1972fea5e
+  metadata.gz: f5ab3329ee346a7873fc30d317a4c41a44895bd70b3448553e0edf787d7deed668b02b1dd74b9c3017ac34fc6bcf6463b3626c13ec162c6b632c7bc881e0f1d9
+  data.tar.gz: 69ea1e0f58d5ad611170f90fd6358bf4cd902f4ddaef3ee9ad4f2934e527c9ebf35760f67c3c9e38ba3c08ec7ee5f0d6c62870bd81c18f32e6c249d23a952baf

data/README.rdoc

@@ -1,3 +1,55 @@
 = EcmCalendarHelper
 
-This project rocks and uses MIT-LICENSE.
+This project rocks and uses MIT-LICENSE.
+
+== Installation
+
+Add it to your Gemfile.
+
+    # Gemfile
+    gem 'ecm_calendar_helper'
+
+== Usage
+
+Add the helper to your controller:
+
+    # app/controllers/application_controller.rb
+    class ApplicationController < ActionController::Base
+      helper Ecm::CalendarHelper
+    end
+
+    # app/controllers/reservations_controller.rb
+    class ApplicationController < ActionController::Base
+      before_action :initialize_calendar
+
+      private
+
+      def initialize_calendar
+        @year  = params[:year]  ||= Time.zone.now.year
+        @month = params[:month] ||= Time.zone.now.month
+
+        @date = Date.strptime("#{@month}-#{@year}", "%m-%Y")
+
+        @collection = Reservation.in_month(@date).all
+      end
+    end
+
+Render the calendar:
+
+    # i.e.app/views/reservations/index.html.haml
+    = month_calendar @date, @collection, display_method: :name, start_day: :monday
+
+== Pagination
+
+Add routes for nice year and month params:
+
+    # config/routes.rb
+    Rails.application.routes.draw do
+      resources :reservations do
+        get "(/:year/:month)", action: :index, on: :collection
+      end
+    end
+
+== Remote rendering
+
+@TODO

data/app/assets/javascripts/ecm/calendar_helper/application/remote_calendar.js.coffee

@@ -0,0 +1,4 @@
+$ ->
+  $('[data-calendar]').each ->
+    url = $(this).attr('data-calendar')
+    $(this).load(url)

data/app/assets/javascripts/ecm/calendar_helper/application.js

@@ -0,0 +1,2 @@
+//= require_self
+//= require_tree ./application

data/app/assets/javascripts/ecm_calendar_helper.js

@@ -0,0 +1 @@
+//= require ecm/calendar_helper/application

data/app/assets/stylesheets/ecm/calendar_helper/application/basic.css

@@ -1,9 +1,15 @@
 @media screen and (max-width: 991px) {
-  .calendar .calendar-weekday-name {
+  .calendar .calendar-weekday {
     display: none;
   }
 }
 
+@media screen and (min-width: 991px) {
+  .calendar .calendar-day-container {
+    height: 7vw;
+  }
+}
+
 .calendar-item {
   border: 1px solid transparent;
   border-radius: 4px;  

data/app/concerns/ecm/calendar_helper/controller/calendar_concern.rb

@@ -0,0 +1,92 @@
+module Ecm
+  module CalendarHelper
+    module Controller
+      # == Usage:
+      # 
+      # Add javascripts:
+      #
+      #    # app/assets/javascripts/application.js
+      #    //= require ecm_calendar_helper
+      #
+      # Add stylesheets:  
+      #
+      #    # app/assets/stylesheets/application.css
+      #    /*
+      #     *= require ecm_calendar_helper
+      #     */
+      # 
+      # Add routes:
+      # 
+      #     # config/routes.rb
+      #     Rails.application.routes.draw do
+      #       resources :calendars, only: [:index], constraints: ->(r) { r.xhr? } do
+      #         get "(/:year/:month)", action: :index, on: :collection
+      #       end
+      #     end
+      #
+      # Add controller:
+      # 
+      #     # app/controllers/calendars_controller.rb
+      #     class CalendarsController < ApplicationController
+      #       include EcmCalendarHelper::Controller::CalendarConcern
+      #   
+      #       private
+      #   
+      #       def load_collection_for_calendar
+      #         @collection = Posts.for_calendar.in_month(@date).all
+      #       end
+      #     end
+      #
+      # Add views:
+      # 
+      #     Copy Ecm::CalendarHelper::Engine.root.join('app/views/ecm/calendar_helper/calendar_concern/*') => app/views/calendars/
+      #
+      # Render the calendar somewhere in your views:
+      # 
+      #     # app/views/*.html.haml
+      #     #calendar{ data: { calendar: calendars_url } }
+      #
+      #
+      module CalendarConcern
+        extend ActiveSupport::Concern
+
+        included do
+          before_action :initialize_calendar_date, only: [:index]
+          before_action :load_collection_for_calendar, only: [:index]
+
+          helper Ecm::CalendarHelper
+          helper_method :calendar_options
+        end
+
+        def index
+          if request.xhr?
+            render layout: nil
+          else
+            render
+          end
+        end
+
+        private
+
+        def initialize_calendar_date
+          @year  = params[:year]  ||= Time.zone.now.year
+          @month = params[:month] ||= Time.zone.now.month
+
+          @date = Date.strptime("#{@month}-#{@year}", "%m-%Y")
+        end
+
+        def load_collection_for_calendar
+          raise 'not implemented'
+        end
+
+        def calendar_options
+          default_calendar_options
+        end
+
+        def default_calendar_options
+          {}
+        end
+      end
+    end
+  end
+end

data/app/helpers/ecm/calendar_helper.rb

@@ -1,11 +1,23 @@
 module Ecm
   module CalendarHelper
     # renders a calendar table
+    #
+    # Example with elements that span more than 1 day:
+    #
+    #     = month_calendar @date, @reservations, start_date_method: :start_at, end_date_method: :end_at
+    #
+    # Example of using a lamda as display method:
+    #
+    #     = month_calendar(display_method: ->(context, resource) { context.link_to(resource.booker.human, resource.booker) })
+    #
     def month_calendar(date = Time.zone.now.to_date, elements = [], options = {})
-      options.reverse_merge! :date_method => :start_at, :display_method => :to_s, :link_elements => true, :start_day => :sunday
+      options.reverse_merge! :date_method => :start_at, :display_method => :to_s, :link_elements => true, :start_day => :sunday, start_date_method: nil, end_date_method: nil
 
       display_method = options.delete(:display_method)
       link_elements  = options.delete(:link_elements)
+
+      start_date_method = options.delete(:start_date_method)
+      end_date_method   = options.delete(:end_date_method)
       
       # calculate beginning and end of month
       beginning_of_month = date.beginning_of_month.to_date
@@ -35,7 +47,13 @@ module Ecm
       last_day = end_of_month.end_of_week
 
       days = (first_day..last_day).each_with_object({}).with_index do |(day, memo), index|
-        memo[day.to_date] = elements.find_all { |e| e.send(options[:date_method]).to_date == day.to_date } || {}
+        memo[day.to_date] = elements.find_all do |e|
+          if start_date_method.present? && end_date_method.present?
+            day.to_date.between?(e.send(start_date_method), e.send(end_date_method))
+          else
+            e.send(options[:date_method]).to_date == day.to_date
+          end
+        end || {}
       end
 
       days_by_week = days.each_with_object({}) { |(k, v), m| (m[k.cweek] ||= {})[k] = v }
@@ -44,15 +62,16 @@ module Ecm
     end
     
     def month_calendar_pagination(date, options = {})
-      options.reverse_merge!(show_today_link: true)
+      options.reverse_merge!(show_today_link: true, remote: false)
 
       show_today_link = options.delete(:show_today_link)
+      remote          = options.delete(:remote)
 
       actual_month   = Time.zone.now.beginning_of_month.to_date
       previous_month = date.beginning_of_month.to_date - 1.month
       next_month     = date.beginning_of_month.to_date + 1.months
 
-      render partial: 'ecm/calendar_helper/month_calendar_pagination', locals: { actual_month: actual_month, previous_month: previous_month, next_month: next_month, show_today_link: show_today_link, date: date }
+      render partial: 'ecm/calendar_helper/month_calendar_pagination', locals: { actual_month: actual_month, previous_month: previous_month, next_month: next_month, show_today_link: show_today_link, date: date, remote: remote }
     end
   end
 end  

data/app/views/ecm/calendar_helper/_month_calendar.haml

@@ -1,8 +1,10 @@
 .calendar
   .flex-row.calendar-weekday-names
     - localized_day_names.each do |day|
-      .column.calendar-weekday-name
-        %h1= day
+      .column
+        .calendar-weekday
+          .column.calendar-weekday-name-container.border.mb-3.p-2
+            %h1= day
 
   - days_by_week.each do |week, days|
     .flex-row{ class: "week-#{week}" }
@@ -13,13 +15,19 @@
         - td_classes << 'with-elements' if elements.any?
         - td_classes << 'not-actual-month' if day.month != Time.zone.now.month
         .column{ class: td_classes.join(" ") }
-          .calendar-day-container
+          .calendar-day-container.border.mb-3.p-2
             %h1.calendar-day-title= day.day
             %div.calendar-entries
             - elements.each do |element|
               %div.calendar-day-content
                 %span.calendar-item.calendar-item-default
+                  - if display_method.nil?
+                    - label = nil
+                  - elsif display_method.respond_to?(:call)
+                    - label = display_method.call(self, element)
+                  - elsif element.respond_to?(display_method)
+                    - label = element.send(display_method)
                   - if link_elements
-                    = link_to(element.send(display_method), element)
+                    = link_to(label, element)
                   - else
-                    = element.send(display_method)
+                    = label

data/app/views/ecm/calendar_helper/_month_calendar_pagination.haml

@@ -1,11 +1,11 @@
-.calendar-pagination
+.calendar-pagination.text-center
   - if show_today_link
-    = link_to(url_for(month: actual_month.month, year: actual_month.year), class: 'btn btn-default calendar-pagination-today') do
+    = link_to(url_for(month: actual_month.month, year: actual_month.year), class: 'btn btn-default btn-link calendar-pagination-today', remote: remote) do
       = t('.today')
   .btn-group
-    = link_to(url_for(month: previous_month.month, year: previous_month.year), class: 'btn btn-primary calendar-pagination-back') do
+    = link_to(url_for(month: previous_month.month, year: previous_month.year), class: 'btn btn-primary calendar-pagination-back', remote: remote) do
       = t('.previous')
     = button_tag(type: 'button', class: 'btn btn-disabled calendar-pagination-actual') do
       = I18n.l(date, format: :month_with_year)
-    = link_to(url_for(month: next_month.month, year: next_month.year), class: 'btn btn-primary calendar-pagination-next') do
+    = link_to(url_for(month: next_month.month, year: next_month.year), class: 'btn btn-primary calendar-pagination-next', remote: remote) do
       = t('.next')

data/app/views/ecm/calendar_helper/calendar_concern/_calendar.html.haml

@@ -0,0 +1,2 @@
+= month_calendar_pagination(date, remote: request.xhr?)
+= month_calendar date, collection, options

data/app/views/ecm/calendar_helper/calendar_concern/index.html.haml

@@ -0,0 +1 @@
+= render partial: 'calendar', locals: { date: @date, collection: @collection, options: calendar_options }

data/app/views/ecm/calendar_helper/calendar_concern/index.js.erb

@@ -0,0 +1 @@
+$('#bookings-calendar').html("<%= escape_javascript(render(partial: 'calendar', locals: { date: @date, collection: @collection, options: calendar_options })) %>");

data/config/initializers/assets.rb

@@ -1 +1 @@
-Rails.application.config.assets.precompile += %w(ecm_calendar_helper.css)
+Rails.application.config.assets.precompile += %w(ecm_calendar_helper.css ecm_calendar_helper.js)

data/config/locales/de.yml

@@ -1,4 +1,7 @@
 de:
+  date:
+    formats:
+      month_with_year: '%B %Y'
   ecm:
     calendar_helper:
       month_calendar_pagination:

data/config/locales/en.yml

@@ -1,4 +1,7 @@
 en:
+  date:
+    formats:
+      month_with_year: '%B %Y'
   ecm:
     calendar_helper:
       month_calendar_pagination:

data/lib/ecm/calendar_helper/version.rb

@@ -1,5 +1,5 @@
 module Ecm
   module CalendarHelper
-    VERSION = "0.0.3"
+    VERSION = "1.0.0"
   end
 end

data/lib/generators/ecm/calendar_helper/controller/controller_generator.rb

@@ -0,0 +1,49 @@
+module Ecm
+  module CalendarHelper
+    module Generators
+      class ControllerGenerator < Rails::Generators::Base
+        desc 'Generates a calendar controller (with views)'
+
+        source_root File.expand_path('../templates', __FILE__)
+
+        attr_reader :base_controller_class_name
+        attr_reader :controller_class_name
+
+        def initialize(*args)
+          super
+          @base_controller_class_name = ENV.fetch('BASE_CONTROLLER_CLASS_NAME') { '::FrontendController' }
+          @controller_class_name = ENV.fetch('CONTROLLER_CLASS_NAME') { 'CalendarsController' }
+        end
+
+        def generate_routes
+          route File.read(File.join(File.expand_path('../templates', __FILE__), 'routes.source'))
+        end
+
+        def generate_controller
+          binding.pry
+          template 'controller.rb', "app/controllers/#{controller_path_name}.rb"
+        end
+
+        def generate_views
+          template 'views/index.html.haml',     "app/views/#{view_path}/index.html.haml"
+          template 'views/index.js.erb',        "app/views/#{view_path}/index.js.erb"
+          template 'views/_calendar.html.haml', "app/views/#{view_path}/_calendar.html.haml"
+        end
+
+        private
+
+        def controller_path_name
+          @controller_class_name.underscore
+        end
+
+        def view_path
+          @controller_class_name.underscore.gsub('_controller', '')
+        end
+
+        def route_name
+          @controller_class_name.demodulize.underscore.pluralize
+        end
+      end
+    end
+  end
+end

data/lib/generators/ecm/calendar_helper/controller/templates/controller.rb

@@ -0,0 +1,18 @@
+class <%= controller_class_name %> < <%= base_controller_class_name %>
+  include Ecm::CalendarHelper::Controller::CalendarConcern
+
+  private
+
+  def load_collection_for_calendar
+    @collection = {}
+  end
+
+  # def calendar_options
+  #   default_calendar_options.merge(
+  #     display_method:    nil,
+  #     start_day:         :monday,
+  #     start_date_method: :start_at,
+  #     end_date_method:   :end_at
+  #   )
+  # end
+end

data/lib/generators/ecm/calendar_helper/controller/templates/initializer.rb

@@ -0,0 +1,42 @@
+Ecm::Blog.configure do |config|
+  # Set the base controller for the page controller
+  #
+  # Default: config.base_controller = '<%= base_controller_class_name %>'
+  #
+  config.base_controller = '<%= base_controller_class_name %>'
+
+  # Class to use for creators and updaters.
+  #
+  # default: config.creator_class_name = 'User'
+  #
+  config.creator_class_name = 'User'
+
+  # Set the page title for the posts index page. Useful for when you use
+  # the blog posts index as main app root page.
+  #
+  # example: config.posts_index_page_title_proc = ->(view) { view.t('.welcome') }
+  #
+  # default: config.posts_index_page_title_proc = ->(view) { view.resource_class.model_name.human(count: :other) }
+  #
+  config.posts_index_page_title_proc = ->(view) { view.resource_class.model_name.human(count: :other) }
+
+  # Set options that will be passed to the paginate call.
+  #
+  # example for bootstrap 3 (You will need to add the bootstrap3-kaminari-views gem to your Gemfile):
+  #
+  #    config.pagination_options_proc = ->(view) { { theme: 'twitter-bootstrap-3' }
+  #
+  # example for bootstrap 4 (You will need to add the bootstrap4-kaminari-views gem to your Gemfile):
+  #
+  #    config.pagination_options_proc = ->(view) { { theme: 'twitter-bootstrap-4' }
+  #
+  # default: config.pagination_options_proc = ->(view) { { theme: 'twitter-bootstrap-4', pagination_class: 'justify-content-center' } }
+  #
+  config.pagination_options_proc = ->(view) { { theme: 'twitter-bootstrap-4', pagination_class: 'justify-content-center' } }
+
+  # Options for rendering the ActiveStorage preview picture in the posts index view.
+  #
+  # Default: config.preview_picture_asset_variant_options = { resize: '320x240' }
+  #
+  config.preview_picture_asset_variant_options = { resize: '320x240' }
+end

data/lib/generators/ecm/calendar_helper/controller/templates/routes.source

@@ -0,0 +1,5 @@
+
+
+  <%= whitespace_from_nesting %>resources :<%= route_name %>, only: [:index], constraints: ->(r) { r.xhr? } do
+  <%= whitespace_from_nesting %>  get "(/:year/:month)", action: :index, on: :collection
+  <%= whitespace_from_nesting %>end

data/lib/generators/ecm/calendar_helper/controller/templates/views/_calendar.html.haml

@@ -0,0 +1,2 @@
+= month_calendar_pagination(date, remote: request.xhr?)
+= month_calendar date, collection, options

data/lib/generators/ecm/calendar_helper/controller/templates/views/index.html.haml

@@ -0,0 +1 @@
+= render partial: 'calendar', locals: { date: @date, collection: @collection, options: calendar_options }

data/lib/generators/ecm/calendar_helper/controller/templates/views/index.js.erb

@@ -0,0 +1 @@
+$('#bookings-calendar').html("<%%= escape_javascript(render(partial: 'calendar', locals: { date: @date, collection: @collection, options: calendar_options })) %>");

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecm_calendar_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Roberto Vasquez Angel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-25 00:00:00.000000000 Z
+date: 2018-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -48,20 +48,34 @@ files:
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
+- app/assets/javascripts/ecm/calendar_helper/application.js
+- app/assets/javascripts/ecm/calendar_helper/application/remote_calendar.js.coffee
+- app/assets/javascripts/ecm_calendar_helper.js
 - app/assets/stylesheets/ecm/calendar_helper/application.css
 - app/assets/stylesheets/ecm/calendar_helper/application/basic.css
 - app/assets/stylesheets/ecm/calendar_helper/application/bootstrap-extensions.css
 - app/assets/stylesheets/ecm/calendar_helper/application/calendar-pagination.css
 - app/assets/stylesheets/ecm_calendar_helper.css
+- app/concerns/ecm/calendar_helper/controller/calendar_concern.rb
 - app/helpers/ecm/calendar_helper.rb
 - app/views/ecm/calendar_helper/_month_calendar.haml
 - app/views/ecm/calendar_helper/_month_calendar_pagination.haml
+- app/views/ecm/calendar_helper/calendar_concern/_calendar.html.haml
+- app/views/ecm/calendar_helper/calendar_concern/index.html.haml
+- app/views/ecm/calendar_helper/calendar_concern/index.js.erb
 - config/initializers/assets.rb
 - config/locales/de.yml
 - config/locales/en.yml
 - lib/ecm/calendar_helper/engine.rb
 - lib/ecm/calendar_helper/version.rb
 - lib/ecm_calendar_helper.rb
+- lib/generators/ecm/calendar_helper/controller/controller_generator.rb
+- lib/generators/ecm/calendar_helper/controller/templates/controller.rb
+- lib/generators/ecm/calendar_helper/controller/templates/initializer.rb
+- lib/generators/ecm/calendar_helper/controller/templates/routes.source
+- lib/generators/ecm/calendar_helper/controller/templates/views/_calendar.html.haml
+- lib/generators/ecm/calendar_helper/controller/templates/views/index.html.haml
+- lib/generators/ecm/calendar_helper/controller/templates/views/index.js.erb
 - lib/tasks/ecm_calendar_helper_tasks.rake
 homepage: https://github.com/robotex82/ecm_calendar_helper.git
 licenses: []