beyond_canvas 0.6.3.pre → 0.6.4.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3084d43396d4fa957f874374cc4248a6480ef1bccf8594b8deeed20ff870b80
-  data.tar.gz: 9fa25549a424dbe10e81a92c2bf2ba38b766a4397b3dd4b83686470229b86bd7
+  metadata.gz: 69b9311ccfa66b8ff9b358476c40005dae8084848abb4408d1deecfacfd485eb
+  data.tar.gz: 2a5ac1f10b54e41f04f997e88b58f37ef52c85a0d63507d0b1a06f053b322ffd
 SHA512:
-  metadata.gz: edc4b271eac2780182729ab41d11e40c853efbbb124d6fbc0a027b20e2a7111892da96ee0ec15cc498e2562b9991eb9962642928c05f2d4a80ed17231ae2d60b
-  data.tar.gz: e1046a986e36093f4c513236258699babeb3d40ba0222d80e0356d16748bcebe34fd8e8887a0f82f13b72048d07a877e6c3d0290128512cc9b75dd0520cd19e7
+  metadata.gz: a214821f18cfd0e7ef9be448f6a7a9b44f0bae9b5e4da1d9154c10f989da2005c7f40ab4b2e7002058b4595a59bf7f8df408ff25bb346a23a1bfa3eebe3b2aa6
+  data.tar.gz: 45a919581e32011b4a64838237601ec2004d327776d861b264551d35442ff0e51202abe9ae1ecc441d7aaad23501a392dda6eefedf54bbb0e06ac0df6dd1d245

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### v0.6.4.pre
+
+* bug-fixes
+  * Fix requiting to create the `_head.html.*` on the project instead of the gem itself
+
 ### v0.6.3.pre
 
 * bug-fixes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    beyond_canvas (0.6.3.pre)
+    beyond_canvas (0.6.4.pre)
       bourbon (~> 5.1)
       inline_svg (~> 1.5)
       sassc-rails (~> 2.1)

data/README.md

@@ -1,35 +1,92 @@
-# BeyondCanvas
+# Beyond Canvas
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/beyond_canvas`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+![Gem Version](https://img.shields.io/gem/v/beyond_canvas?label=gem%20version)
+![License](https://img.shields.io/github/license/ePages-de/beyond_canvas)
 
 ## Installation
 
-Add this line to your application's Gemfile:
+1. Add this line to your application's Gemfile:
+
+    ```ruby
+    gem "beyond_canvas"
+    ```
+
+1. Then execute:
+
+    ```bash
+    $ bundle install
+    ```
+
+1. Restart your server and rename `application.css` to `application.scss` or `application.sass` (in case you prefer to use `sass` syntax):
+
+    ```bash
+    $ mv app/assets/stylesheets/application.css app/assets/stylesheets/application.scss
+    ```
+
+1. Delete _all_ Sprockets directives in `application.scss` (`require`, `require_tree` and `require_self`) and use Sass’s native `@import` instead ([why?](https://content.pivotal.io/blog/structure-your-sass-files-with-import)).
+
+1. Import Beyond Canvas at the beginning of `application.scss`. Any other styles must be imported after Beyond Canvas to avoid issues:
+
+    ```scss
+    @import 'beyond_canvas'
+    ```
+
+1. Add the following to `application.js`:
+
+    ```js
+    //= require beyond_canvas
+    ```
 
-```ruby
-gem 'beyond_canvas'
-```
+1. Run the generator:
 
-And then execute:
+    ```bash
+    $ rails g beyond_canvas:install
+    ```
 
-    $ bundle
+    This will generate 2 new files:
 
-Or install it yourself as:
+    1. `config/initializers/beyond_canvas.rb`, used for general Beyond Canvas configuration and
+    2. `config/initializers/beyond_canvas_form_utils.rb`, needed for changing the form generation behavior
 
-    $ gem install beyond_canvas
+## Style Customization
 
-## Usage
+Beyond Canvas comes with _out-of-the-box_ styles to make your app look as a Beyond integrated one. If you want to customize the gem styles, follow these instructions:
 
-TODO: Write usage instructions here
+1. Run the custom style generator:
 
-## Development
+    ```bash
+    $ rails g beyond_canvas:custom_styles
+    ```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+    This command will generate a file (`app/assets/stylesheets/_beyond_canvas_custom_styles.sass`) that contains all variables you can customize.
 
-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).
+1. Import the custom styles **before** Beyond Canvas itself (to override the default styles) on `application.scss`:
+
+    ```scss
+    @import 'beyond_canvas_custom_styles'
+    @import 'beyond_canvas'
+    ```
+
+## Documentation
+
+TBD
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/beyond_canvas.
+Please see [CONTRIBUTING](https://github.com/ePages-de/beyond_canvas/blob/master/CONTRIBUTING.md).
+
+## Changelog
+
+Beyond Canvas's changelog is available [here](https://github.com/ePages-de/beyond_canvas/blob/master/CHANGELOG.md).
+
+## License
+
+beyond_canvas is Copyright © 2019 ePages GmbH. It is free software, and may be redistributed under the terms specified in the [LICENSE](https://github.com/ePages-de/beyond_canvas/blob/master/LICENSE) file.
+
+## About ePages
+
+As the largest independent provider of online shop software in Europe, ePages specialises in high-performance ecommerce solutions for small and medium-sized businesses.
+Today, 100,000 companies in 70 countries operate professional online shops with ePages software in the cloud.
+
+And we love open source software!
+Check out our [other projects](https://github.com/ePages-de), or [become part of our team](https://developer.epages.com/devjobs/) and develop great ecommerce software with us!

data/app/views/beyond_canvas/shared/_head.html.slim

@@ -0,0 +1,12 @@
+head
+  = csrf_meta_tags
+  meta content='width=device-width, initial-scale=1.0' name='viewport' /
+  link crossorigin="anonymous" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" rel="stylesheet" /
+  script src="https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js"
+  - if defined? Turbolinks
+    = stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track': 'reload'
+    = javascript_include_tag 'application', 'data-turbolinks-track': 'reload'
+  - else
+    = stylesheet_link_tag 'application'
+    = javascript_include_tag 'application'
+  = render 'beyond_canvas/custom/public_head'

data/app/views/beyond_canvas/shared/_logo.html.slim

@@ -0,0 +1,2 @@
+- logo = BeyondCanvas.configuration.public_logo
+= logo_image_tag(logo) unless logo.nil?

data/app/views/layouts/beyond_canvas/public.html.slim

@@ -1,17 +1,11 @@
 doctype html
 
 html
-  head
-    = csrf_meta_tags
-    meta content='width=device-width, initial-scale=1.0' name='viewport' /
-    link crossorigin="anonymous" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" rel="stylesheet" /
-    script src="https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js"
-    = render 'beyond_canvas/custom/public_head'
+  = render 'beyond_canvas/shared/head'
 
   body.body--public
     main.main class=("#{params[:controller].gsub(/[\/_]/, "-")}--#{params[:action]}")
-      = render 'beyond_canvas/flash'
+      = render 'beyond_canvas/shared/flash'
       .main-wrapper
-        - logo = BeyondCanvas.configuration.public_logo
-        = logo_image_tag(logo) unless logo.nil?
+        = render 'beyond_canvas/shared/logo'
         = yield

data/lib/beyond_canvas/version.rb

@@ -1,3 +1,3 @@
 module BeyondCanvas
-  VERSION = "0.6.3.pre".freeze
+  VERSION = "0.6.4.pre".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beyond_canvas
 version: !ruby/object:Gem::Version
-  version: 0.6.3.pre
+  version: 0.6.4.pre
 platform: ruby
 authors:
 - Unai Abrisketa
@@ -118,10 +118,11 @@ files:
 - app/assets/stylesheets/utilities/_mixins.sass
 - app/form_builders/beyond_form_builder.rb
 - app/helpers/beyond_canvas_helper.rb
-- app/views/beyond_canvas/_flash.html.slim
 - app/views/beyond_canvas/custom/_public_head.html.slim
+- app/views/beyond_canvas/shared/_flash.html.slim
+- app/views/beyond_canvas/shared/_head.html.slim
+- app/views/beyond_canvas/shared/_logo.html.slim
 - app/views/layouts/beyond_canvas/public.html.slim
-- app/views/layouts/beyond_canvas/single_page.html.slim
 - beyond_canvas.gemspec
 - lib/beyond_canvas.rb
 - lib/beyond_canvas/version.rb

data/app/views/layouts/beyond_canvas/single_page.html.slim

@@ -1,20 +0,0 @@
-doctype html
-
-html
-  head
-    = csrf_meta_tags
-    meta content='width=device-width, initial-scale=1.0' name='viewport' /
-    link crossorigin="anonymous" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" rel="stylesheet" /
-    script src="https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js"
-    = render 'beyond_canvas/custom/public_head'
-
-  body.body--single-page
-    main.main class=("#{params[:controller].gsub(/[\/_]/, "-")}--#{params[:action]}")
-      .main-wrapper
-        - logo = Dir["app/assets/images/logo.*"].first
-        - unless logo.nil?
-          - if File.extname(logo) == '.svg'
-            = inline_svg File.basename(logo), class: 'logo'
-          - else
-            = image_tag File.basename(logo), class: 'logo'
-        = yield