krant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16fca9a5203f41e933e1708ca649373a256c10e4d2f0ac45759a4555a956a408
+  data.tar.gz: 935126c44cc0a3fd0c5de5a360016ae66e20b0faa41733ebe04c639d2775c41b
+SHA512:
+  metadata.gz: ede4f46671bf12e023594dc0822db6c3e653d38481d76bc943f0df97e991d924cb5ef78f4930828e1c5501a1f4311464effb394168677f42e2609b85a048446d
+  data.tar.gz: 1e668b5be312e32b4be57f54a1fe5ed301761a66852086dd51b1a56d907b2ac9104a33d20f1fa70441abe836f4c94c5de7c59b2b2c247b0ef6e70c489ac2b425

data/.gitignore

@@ -0,0 +1,13 @@
+.bundle/
+/.yardoc
+/Gemfile.lock
+/gemfiles/*.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/internal/tmp
+/spec/internal/db/*.sqlite
+/spec/examples.txt

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+# The default of 80 characters is a little to narrow.
+Metrics/LineLength:
+  Max: 100
+
+# Do not warn about missing magic comment
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Allow using {} when chaining methods
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 2.3.4
+
+# Use container based travis infrastructure which allows caching
+# features for open source projects.
+sudo: false
+cache:
+  bundler: true
+
+gemfile:
+  - gemfiles/rails_4.2_active_admin_1.0.0.pre4.gemfile
+  - gemfiles/rails_4.2_active_admin_1.0.gemfile
+  - gemfiles/rails_4.2_active_admin_1.1.gemfile
+
+script: bundle exec rspec

data/Appraisals

@@ -0,0 +1,14 @@
+appraise 'rails-4.2-active-admin-1.0.0.pre4' do
+  gem 'rails', '~> 4.2'
+  gem 'activeadmin', '1.0.0.pre4'
+end
+
+appraise 'rails-4.2-active-admin-1.0' do
+  gem 'rails', '~> 4.2'
+  gem 'activeadmin', '~> 1.0'
+end
+
+appraise 'rails-4.2-active-admin-1.1' do
+  gem 'rails', '~> 4.2'
+  gem 'activeadmin', '~> 1.1'
+end

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG
+
+### Version 0.1.0
+
+2017-12-15
+
+- Initial release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tfischbach@codevise.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in krant.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tim Fischbach
+
+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,192 @@
+# Krant
+
+[![Gem Version](https://badge.fury.io/rb/krant.svg)](http://badge.fury.io/rb/krant)
+[![Build Status](https://travis-ci.org/codevise/krant.svg?branch=master)](https://travis-ci.org/codevise/krant)
+
+Display app news and broadcast messages in Active Admin.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'krant'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Include javascripts and stylesheets:
+
+```scss
+// app/assets/stylesheets/active_admin.scss
+
+// After active_admin/base has been imported
+@import "krant/active_admin";
+```
+
+Install migrations and migrate:
+
+```
+$ bin/rake krant:install:migrations
+$ bin/rake db:migrate
+```
+
+### Display Broadcast Messages
+
+Configure the Active Admin view component and add the broadcast
+messages admin to the load path:
+
+```ruby
+# config/initializers/active_admin.rb
+ActiveAdmin.application.load_paths.unshift(Krant.active_admin_load_path)
+
+ActiveAdmin.setup do |config|
+  config.view_factory.header = Krant::Views::HeaderWithBroadcastMessages
+end
+```
+
+Configure for which locales you want to enter broadcast message
+translations. The corresponding text fields will be displayed:
+
+```ruby
+# config/initializers/krant.rb
+Krant.broadcast_message_locales = [:en, :fr, :es]
+```
+
+Messages with different translations can now be configured via the
+admin interface and will be displayed once marked as active.
+
+The color of the broadcast message bar can be configured via SCSS
+
+```scss
+// app/assets/stylesheets/active_admin.scss
+
+$krant-broadcast-message-bar-color: #fff3bd;
+$krant-broadcast-message-bar-border-color: transparent;
+
+@import "krant/active_admin";
+```
+
+### Displaying a News Page
+
+Provide a news collection:
+
+```ruby
+# lib/my_app.rb
+module MyApp
+  def self.news
+    @news ||= Krant::News.about(MyApp)
+  end
+end
+```
+
+The passed parameter is only used as a namespace for item names. You
+can also pass a string. Passing a constant is an easy way to ensure
+uniqness.
+
+Add a news page:
+
+```ruby
+# app/admins/news.rb
+ActiveAdmin.register_page 'news' do
+  Krant.active_admin_news_page(self)
+
+  content title: 'News' do
+    krant_news_list(MyApp.news)
+  end
+end
+```
+
+If you are using the CanCan authorization adapter, grant access to the
+page and its `seen` action:
+
+```ruby
+# app/models/ability.rb
+can [:read, :seen], ActiveAdmin::Page, name: 'news'
+```
+
+Add a link to the news page into the utility navigation:
+
+```ruby
+# config/initializers/active_admin.rb
+config.namespace :admin do |admin|
+  admin.build_menu :utility_navigation do |menu|
+    Krant.add_active_admin_news_menu_item_to(menu,
+                                             news: MyApp.news,
+                                             url: -> { admin_news_path })
+  end
+end
+```
+Create news items for new features:
+
+```ruby
+# config/initializers/news/some_new_feature.rb
+MyApp.news.item(:some_new_feature,
+                 title: {
+                   en: 'Some title',
+                   de: 'Ein Titel'
+                 },
+                 body: {
+                   en: 'Some text using [Markdown](http://http://commonmark.org/).',
+                   de: 'Text mit [Markdown](http://http://commonmark.org/).',
+                 })
+```
+
+Define a Rake tasks to persists news items in the database:
+
+```ruby
+# Rakefile
+require 'krant/tasks'
+Krant::Trasks.install { MyApp.news }
+```
+
+and run the defined task after each deploy:
+
+```
+$ bin/rake news:persist
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install
+dependencies. You can also run `bin/console` for an interactive prompt
+that will allow you to experiment.
+
+To run the tests install bundled gems and invoke RSpec:
+
+```
+$ bundle
+$ bundle exec rspec
+```
+
+The test suite can be run against different versions of Rails and
+Active Admin (see `Appraisals` file):
+
+```
+$ appraisal install
+$ appraisal rspec
+```
+
+To install this gem onto your local machine, run `bundle exec rake
+install`. To release a new version, update the version number in
+`version.rb`, and then run `bundle exec rake release`, which will
+create a git tag for the version, push git commits and tags, and push
+the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/codevise/krant. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected
+to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of
+conduct.
+
+## 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,4 @@
+require 'bundler/gem_tasks'
+
+require 'semmy'
+Semmy::Tasks.install

data/admin/krant/broadcast_messages.rb

@@ -0,0 +1,56 @@
+module Krant
+  ActiveAdmin.register BroadcastMessage, as: 'BroadcastMessage' do
+    menu priority: 100
+
+    actions :index, :new, :create, :edit, :update, :destroy
+
+    config.batch_actions = false
+    config.filters = false
+
+    index do
+      column :text do |broadcast_message|
+        div do
+          broadcast_message.translations.each do |t|
+            div class: 'krant-broadcast-messages-table-text' do
+              span "#{t.locale}:", class: 'krant-broadcast-messages-table-text-locale'
+              span t.text, class: 'krant-broadcast-messages-table-text-translation'
+            end
+          end
+        end
+      end
+      column :active
+      column :updated_at
+      column :created_at
+      actions
+    end
+
+    form do |f|
+      f.inputs do
+        f.input :active
+
+        f.semantic_fields_for :translations do |t|
+          t.input(:text,
+                  as: :string,
+                  label: I18n.t('krant.admin.broadcast_messages.text_translation_label',
+                                locale_name: t.object.locale))
+          t.input :locale, as: :hidden
+        end
+      end
+      f.actions
+    end
+
+    after_build do |broadcast_message|
+      Krant.broadcast_message_locales.each do |locale|
+        broadcast_message.translations.detect do |t|
+          t.locale == locale.to_s
+        end || broadcast_message.translations.build(locale: locale)
+      end
+    end
+
+    controller do
+      def permitted_params
+        params.permit(broadcast_message: [:active, translations_attributes: [:id, :text, :locale]])
+      end
+    end
+  end
+end