html_calendar 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fbc1ec30f44e2c6a8cd4022e592742c661d4a66b
+  data.tar.gz: f498ca9d1a674e979fed818c5832a40deb48f0bb
+SHA512:
+  metadata.gz: 1a2ee5248957f00e6e70362e35de851dcd6cd86cb06bfa7d68627ccfa1c4c24b7a13104ca3e68eac784a5927cf8c9ae66d4497c5970a5b357530523265fc10f4
+  data.tar.gz: 7dcf51896b41546066918af2b031a98d12a8782144eba101d1e5f53ac58a1dd9f1cfa572c3ecf9fa4df88a2dbabb7cec06b501950e3f46baff47e662a00f48cb

data/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contributing
+
+Pull requests are empirically awesome, and are most welcome.
+
+1. [Fork the project](https://help.github.com/articles/fork-a-repo).
+2. Create a branch - `git checkout -b adding_magic`
+3. Make your changes, and add some tests!
+4. Check that the tests pass - `bundle exec rake`
+5. Commit your changes - `git commit -am "Added some magic"`
+6. Push the branch to Github - `git push origin adding_magic`
+7. Send us a [pull request](https://help.github.com/articles/using-pull-requests)!

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Carnes Media
+
+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,74 @@
+# HtmlCalendar
+
+HtmlCalendar is an extremely lightweight/extensible gem for creating HTML
+calendars in Rails (>= 3.1).
+
+Want to overwrite the built-in views? No problem. Want clean markup? It'll give
+you clean markup. Want a full-featured Google Calendar clone? It'll give you
+clean markup.
+
+## Installation
+
+1. Add `gem "html_calendar"` to your `Gemfile`
+2. `bundle`
+
+## Creating calendars
+
+The `html_calendar` helper makes it easy to create a calendar for any date:
+
+```erb
+<!-- a calendar for the current month -->
+<%= html_calendar %>
+
+<!-- a calender for 3 months in the future -->
+<%= html_calendar Date.current + 3.months %>
+```
+
+If you need customized date logic, you can also pass `html_calendar` a presenter:
+
+```erb
+<%= html_calendar Date.current, presenter: MyCustomDatePresenter %>
+```
+
+Your presenter class needs to inherit from `HTMLCalendar::DatePresenter`, and
+should implement the `html_classes` method.
+
+```ruby
+class MyCustomDatePresenter < HTMLCalendar::DatePresenter
+  # Available methods: `html_classes`, `date` and `template`
+
+  def html_classes
+    if monday?
+      ['a-case-of-the-mundays']
+    else
+      super
+    end
+  end
+
+  private
+
+  def monday?
+    date.wday == 1
+  end
+end
+```
+
+
+## Overwriting views
+
+You can overwrite any of the [view partials](https://github.com/carnesmedia/html_calendar/tree/master/app/views/html_calendar/calendar) by creating a directory at `app/views/html_calendar/calendar` and adding replacement files:
+
+| Name                        | Description                                                 |
+| -------------               |-------------                                                |
+| `_calendar.html.erb`        | Main calendar loop                                          |
+| `_day.html.erb`             | Single day cell (in current month)                          |
+| `_header.html.erb`          | Table header (including day names)                          |
+| `_other_month_day.html.erb` | Single day cell for days displayed but not in current month |
+
+
+## Future Plans
+
+* I18n support
+* Better test coverage
+* Basic stylesheet (opt-in)
+* Ability to overwrite partial path

data/Rakefile

@@ -0,0 +1,13 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/helpers/html_calendar_helper.rb

@@ -0,0 +1,5 @@
+module HtmlCalendarHelper
+  def html_calendar(month = Date.current, options = {})
+    HTMLCalendar::Calendar.new self, month, options
+  end
+end

data/app/views/html_calendar/calendar/_calendar.html.erb

@@ -0,0 +1,14 @@
+<table class="calendar">
+  <thead>
+    <%= calendar.render_header %>
+  </thead>
+  <tbody>
+    <% calendar.renderable_date_range_in_weeks.each do |week_days| %>
+      <tr>
+        <% week_days.each do |date| %>
+          <%= calendar.render_date date %>
+        <% end %>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/html_calendar/calendar/_day.html.erb

@@ -0,0 +1,3 @@
+<td class="day <%= presenter.html_classes %>" data-date="<%= date %>">
+  <span><%= date.day %></span>
+</td>

data/app/views/html_calendar/calendar/_header.html.erb

@@ -0,0 +1,14 @@
+<tr>
+  <th colspan="7">
+    <%= month.to_date.strftime '%B' %>
+  </th>
+</tr>
+<tr>
+  <th>SU</th>
+  <th>MO</th>
+  <th>TU</th>
+  <th>WE</th>
+  <th>TH</th>
+  <th>FR</th>
+  <th>SA</th>
+</tr>

data/app/views/html_calendar/calendar/_other_month_day.html.erb

@@ -0,0 +1,3 @@
+<td class="other_month_day">
+  <span><%= date.day %></span>
+</td>

data/lib/html_calendar.rb

@@ -0,0 +1,7 @@
+require 'html_calendar/month'
+require 'html_calendar/date_presenter'
+require 'html_calendar/calendar'
+require "html_calendar/engine"
+
+module HTMLCalendar
+end

data/lib/html_calendar/calendar.rb

@@ -0,0 +1,62 @@
+module HTMLCalendar
+  class Calendar
+    attr_reader :template, :month, :options
+
+    def initialize(template, month, options = {})
+      @template = template
+      @month = Month.new(month)
+      @options = options
+    end
+
+    delegate :date_range,
+      to: :month
+
+    def to_s
+      render 'calendar', calendar: self
+    end
+
+    def renderable_date_range
+      beginning_of_month.at_beginning_of_week(:sunday)..end_of_month.at_end_of_week(:sunday)
+    end
+
+    def renderable_date_range_in_weeks
+      renderable_date_range.to_a.in_groups_of(7)
+    end
+
+    def render_header
+      render 'header', month: month
+    end
+
+    def render_date(date)
+      partial_name = in_month?(date) ? 'day' : 'other_month_day'
+      render partial_name, date: date, presenter: date_presenter_for(date)
+    end
+
+    def in_month?(date)
+      date_range.include? date
+    end
+
+    def prefix
+      self.class.name.underscore
+    end
+
+    private
+
+    def date_presenter_for(date)
+      options.fetch(:presenter, DatePresenter).new(template, date)
+    end
+
+    def render(partial, locals)
+      partial_path = [prefix, partial].join('/')
+      template.render partial: partial_path, locals: locals.merge(calendar: self)
+    end
+
+    def beginning_of_month
+      month.at_beginning_of_month
+    end
+
+    def end_of_month
+      month.at_end_of_month
+    end
+  end
+end

data/lib/html_calendar/date_presenter.rb

@@ -0,0 +1,12 @@
+module HTMLCalendar
+  class DatePresenter
+    attr_reader :template, :date
+    def initialize(template, date)
+      @template, @date = template, date
+    end
+
+    def html_classes
+      []
+    end
+  end
+end

data/lib/html_calendar/engine.rb

@@ -0,0 +1,9 @@
+module HTMLCalendar
+  class Engine < ::Rails::Engine
+    initializer 'html_calendar.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        helper HtmlCalendarHelper
+      end
+    end
+  end
+end

data/lib/html_calendar/month.rb

@@ -0,0 +1,20 @@
+module HTMLCalendar
+  class Month
+
+    def initialize(date)
+      @date = date.at_beginning_of_month.to_date
+    end
+
+    def date_range
+      at_beginning_of_month..at_end_of_month
+    end
+
+    delegate :to_date, :at_beginning_of_month, :at_end_of_month,
+      to: :date
+
+    private
+    # Date stores the first of the month
+    attr_reader :date
+  end
+
+end

data/lib/html_calendar/version.rb

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

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: html_calendar
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Amiel Martin
+- Nathan Carnes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: HtmlCalendar is an extremely lightweight/extensible gem for creating
+  HTML calendars in Rails (>= 3.1).
+email:
+- amiel@carnesmedia.com
+- nathan@carnesmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTING.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/helpers/html_calendar_helper.rb
+- app/views/html_calendar/calendar/_calendar.html.erb
+- app/views/html_calendar/calendar/_day.html.erb
+- app/views/html_calendar/calendar/_header.html.erb
+- app/views/html_calendar/calendar/_other_month_day.html.erb
+- lib/html_calendar.rb
+- lib/html_calendar/calendar.rb
+- lib/html_calendar/date_presenter.rb
+- lib/html_calendar/engine.rb
+- lib/html_calendar/month.rb
+- lib/html_calendar/version.rb
+homepage: https://github.com/carnesmedia/html_calendar
+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.2.0
+signing_key: 
+specification_version: 4
+summary: A lightweight gem for creating HTML calendars in Rails.
+test_files: []