simple_calendar 2.4.1 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60dcc26bdf5d0e6bc7eed23fe0bf3d5c35977b8a189b9a045897410abc4ce36e
-  data.tar.gz: cc92323a3b5766f2f428ff1e3adfa40641843ddd5fce25068aeb7eee224ca710
+  metadata.gz: 63d197eaa28493e06d8dc46901a694f045ab97828fe9d4aa15f464885ba111d3
+  data.tar.gz: 19142bc24ec86bde21bde2ecb016f45bff50d7980fdc34e662223ecc86d7baf6
 SHA512:
-  metadata.gz: d7ad3f165f583b789c6b8f8300c8377eac55cac5cb138429435185a6f50ee4b4b276b4d56e75e396ff1bce3f612b9029f1aa69023e6464346de3118d1aa3d580
-  data.tar.gz: 994a400d806c3a3c06939828d64254efad0dd04c34c00dab5a21a842e7ff7460d4e9bb2cb988cedeec0686360e91f53ebe99697979aaf5d23ab342136c771137
+  metadata.gz: b9b4785dd7284857513ae068d5400659dd81970169f2c1508fe85459a8ff1e48848f1157e11c6ce5fa1785f08eb12485d2f21e12e7f5ee2d2e08869d161ac8f0
+  data.tar.gz: a6329290641565e430a3f9ab089d1da639fe69a9d5b5715b9846b2b987dd0d8d8aa7c850b94c1238e21357a47a1c4bff9c39a9e76ecb0370bd29ef553c22394f

data/.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - master
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.7', '3.0']
+        gemfile:
+          - rails_6
+          - rails_6_1
+          - rails_master
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+      BUNDLE_PATH_RELATIVE_TO_CWD: true
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler: default
+          bundler-cache: true
+
+      - name: StandardRb check
+        run: bundle exec standardrb
+
+      - name: Run tests
+        env:
+          DATABASE_URL: "sqlite3:noticed_test"
+          RAILS_ENV: test
+        run: |
+          bundle exec rails db:test:prepare
+          bundle exec rails test

data/Appraisals

@@ -0,0 +1,11 @@
+appraise "rails-6" do
+  gem "rails", "~> 6.0.0"
+end
+
+appraise "rails-6-1" do
+  gem "rails", "~> 6.1.0"
+end
+
+appraise "rails-master" do
+  gem "rails", github: "rails/rails"
+end

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 2.4.2
+
+* Translation improvements - @fwolfst
+
 ### 2.4.1
 
 * [FIX] Use iso8601 format for start_date links in the header. Fixes any

data/Gemfile

@@ -1,3 +1,6 @@
 source "http://rubygems.org"
 
 gemspec
+
+gem "appraisal"
+gem "standard"

data/README.md

@@ -1,16 +1,17 @@
-![travis ci](https://travis-ci.org/excid3/simple_calendar.svg?branch=master)
+# Simple Calendar
 
-Simple Calendar
-===============
+### 📆 A calendar for your Ruby on Rails app.
 
-Simple Calendar is designed to do one thing really really well: render a
-calendar. It lets you render a calendar of any size. Maybe you want a
+[![Build Status](https://github.com/excid3/simple_calendar/workflows/Tests/badge.svg)](https://github.com/excid3/simple_calendar/actions) [![Gem Version](https://badge.fury.io/rb/simple_calendar.svg)](https://badge.fury.io/rb/simple_calendar)
+
+Simple Calendar is designed to do one thing really really well: render a calendar. 
+
+It lets you render a calendar of any size. Maybe you want a
 day view, a 4 day agenda, a week view, a month view, or a 6 week
 calendar. You can do all of that with the new gem, just give it a range
 of dates to render.
 
-It doesn't depend on any ORM so you're free to use it with ActiveRecord,
-Mongoid, any other ORM, or pure Ruby objects.
+It doesn't depend on any ORM so you're free to use it with ActiveRecord, Mongoid, any other ORM, or pure Ruby objects.
 
 Thanks to all contributors for your wonderful help!
 
@@ -21,7 +22,7 @@ Installation
 
 Just add this into your Gemfile followed by a bundle install:
 ```ruby
-gem "simple_calendar", "~> 2.0"
+gem "simple_calendar", "~> 2.4"
 ```
 
 If you're using Bootstrap, the calendar should already have a border and
@@ -34,6 +35,13 @@ your `app/assets/stylesheets/application.css` file:
 *= require simple_calendar
 ```
 
+or in your SCSS `app/assets/stylesheets/application.scss` file:
+
+```scss
+@import "simple_calendar";
+```
+
+
 Usage
 -----
 
@@ -62,7 +70,7 @@ To show the day of the month instead of the date, use `<%= date.day %>`
 You can generate a week calendar with the `week_calendar` method.
 
 ```erb
-<%= week_calendar number_of_weeks: 2 do |date| %>
+<%= week_calendar(number_of_weeks: 2) do |date| %>
   <%= date %>
 <% end %>
 ```
@@ -74,7 +82,7 @@ Setting `number_of_weeks` is optional and defaults to 1.
 You can generate calendars of any length by passing in the number of days you want to render.
 
 ```erb
-<%= calendar number_of_days: 4 do |date| %>
+<%= calendar(number_of_days: 4) do |date| %>
   <%= date %>
 <% end %>
 ```
@@ -87,7 +95,7 @@ You can pass in `start_date_param` to change the name of the parameter
 in the URL for the current calendar view.
 
 ```erb
-<%= calendar start_date_param: :my_date do |date| %>
+<%= calendar(start_date_param: :my_date) do |date| %>
   <%= date %>
 <% end %>
 ```
@@ -97,11 +105,38 @@ in the URL for the current calendar view.
 You can set a different partial name for calendars by passing the partial path.
 
 ```erb
-<%= calendar partial: 'products/calendar' do |date| %>
+<%= calendar(partial: 'products/calendar') do |date| %>
   <%= date %>
 <% end %>
 ```
 
+### Internationalization (I18n)
+
+The default views are prepared to do translation lookups for month names and weekdays.
+
+To profit from that, you can take advantage of the [`rails-i18n`](https://github.com/svenfuchs/rails-i18n/) gem which comes with translations for many languages already.
+
+In a Rails 6 app, the configuration could look like the following:
+
+  * Add `gem 'rails-i18n'` to your `Gemfile` and run `bundle`.
+  * Define the available and default locale e.g. in `config/application.rb`:
+```ruby  
+# config/application.rb
+config.i18n.available_locales = [:en, :de, :fr]
+config.i18n.default_locale = :en
+```
+  * Define the following translation keys:
+```yaml
+# e.g. config/locales/de.yml
+de:
+  simple_calendar:
+    previous: "<<"
+    next: ">>"
+    week: Woche
+```
+       
+See the [Rails I18n Guide](https://guides.rubyonrails.org/i18n.html) for further information.
+
 ## Rendering Events
 
 What's a calendar without events in it? There are two simple steps for creating
@@ -120,7 +155,7 @@ $ rails g scaffold Meeting name start_time:datetime
 $ rails g scaffold Meeting name start_time:datetime end_time:datetime
 ```
 
-By default it uses `start_time` as the attribute name.  
+By default it uses `start_time` as the attribute name.
 **If you'd like to use another attribute other than start_time, just
 pass it in as the `attribute`**
 
@@ -160,7 +195,9 @@ We'll just load up all the meetings for this example.
 
 ```ruby
 def index
-  @meetings = Meeting.all
+  # Scope your query to the dates being shown:
+  start_date = params.fetch(:start_date, Date.today).to_date
+  @meetings = Meeting.where(starts_at: start_date.beginning_of_month.beginning_of_week..start_date.end_of_month.end_of_week)
 end
 ```
 
@@ -168,7 +205,7 @@ Then in your view, you can pass in the `events` option to render. The
 meetings will automatically be filtered out by day for you.
 
 ```erb
-<%= month_calendar events: @meetings do |date, meetings| %>
+<%= month_calendar(events: @meetings) do |date, meetings| %>
   <%= date %>
 
   <% meetings.each do |meeting| %>
@@ -383,6 +420,10 @@ Chris Oliver <chris@gorails.com>
 
 [@excid3](https://twitter.com/excid3)
 
+## License
+
+Simple Calendar is licensed under the [MIT License](LICENSE.txt).
+
 ## Support
 
 Need help

data/Rakefile

@@ -1,7 +1,7 @@
 require "bundler/gem_tasks"
 
 begin
-  require 'rspec/core/rake_task'
+  require "rspec/core/rake_task"
   RSpec::Core::RakeTask.new(:spec)
   task default: :spec
 rescue LoadError

data/app/views/simple_calendar/_week_calendar.html.erb

@@ -2,11 +2,11 @@
   <div class="calendar-heading">
     <%= link_to t('simple_calendar.previous', default: 'Previous'), calendar.url_for_previous_view %>
     <% if calendar.number_of_weeks == 1 %>
-      <span class="calendar-title">Week <%= calendar.week_number %></span>
-    <%else%>
-        <span class="calendar-title">Week <%= calendar.week_number %> - <%= calendar.end_week %></span>
-    <%end%>
-        <%= link_to t('simple_calendar.next', default: 'Next'), calendar.url_for_next_view %>
+      <span class="calendar-title"><%= t('simple_calendar.week', default: 'Week') %> <%= calendar.week_number %></span>
+    <% else %>
+      <span class="calendar-title"><%= t('simple_calendar.week', default: 'Week') %> <%= calendar.week_number %> - <%= calendar.end_week %></span>
+    <% end %>
+    <%= link_to t('simple_calendar.next', default: 'Next'), calendar.url_for_next_view %>
   </div>
 
   <table class="table table-striped">

data/gemfiles/rails_6.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "appraisal"
+gem "standard"
+gem "rails", "~> 6.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_6.gemfile.lock

@@ -0,0 +1,197 @@
+PATH
+  remote: ..
+  specs:
+    simple_calendar (2.4.2)
+      rails (>= 3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actioncable (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      actionview (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.3.4)
+      actionview (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.3.4)
+      activesupport (= 6.0.3.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.4)
+      activesupport (= 6.0.3.4)
+      globalid (>= 0.3.6)
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activestorage (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      marcel (~> 0.3.1)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    appraisal (2.3.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.8)
+      concurrent-ruby (~> 1.0)
+    loofah (2.9.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.6)
+    mini_mime (1.0.2)
+    mini_portile2 (2.5.0)
+    minitest (5.14.3)
+    nio4r (2.5.4)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    nokogiri (1.11.1-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.11.1-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.3.4)
+      actioncable (= 6.0.3.4)
+      actionmailbox (= 6.0.3.4)
+      actionmailer (= 6.0.3.4)
+      actionpack (= 6.0.3.4)
+      actiontext (= 6.0.3.4)
+      actionview (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      bundler (>= 1.3.0)
+      railties (= 6.0.3.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.8.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    standard (0.12.0)
+      rubocop (= 1.8.1)
+      rubocop-performance (= 1.9.2)
+    thor (1.1.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    unicode-display_width (2.0.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  appraisal
+  rails (~> 6.0.0)
+  rspec
+  simple_calendar!
+  standard
+
+BUNDLED WITH
+   2.2.13