headmin 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9f3322a28300a8474d9e3eb6de7426ffc1e29ce1d335538acecc185b7a0a622
+  data.tar.gz: c8ed8550f75532b996fe507407abf724f0899e0db61d1881a2320ff97a0fa0fe
+SHA512:
+  metadata.gz: 252e757eb913f233271e7b41f474dada9913446af1ef48cc2b2d55d435e2d5b9dfab8199c18ebbb6a19cd260541ea1c1bc996bf1feecd9d8ee67a779ada5a1d3
+  data.tar.gz: 0d7c2ec678aea04c6317af5117d91ca622f08754a532d7baa93478925d509bf569783d828ea4b43053aca2d48c427bf6b13fd4e07701c32b8fa363a239efcf39

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/node_modules/
+
+# Ingore editors
+/.idea
+/headmin.iml

data/.nvmrc

@@ -0,0 +1 @@
+lts/*

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.0.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.0.1] - 2021-03-14
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at vlamingsjef@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in headmin.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    headmin (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rubocop (1.11.0)
+      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)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-darwin-20
+
+DEPENDENCIES
+  headmin!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.14

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jef Vlamings
+
+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,166 @@
+# Headmin
+A complete library of commonly used components to build an admin interface in your Ruby on Rails project.
+
+For information about different features: [click here](docs/README.md)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'headmin'
+```
+
+And then execute:
+
+```shell
+$ bundle install
+```
+
+Add headmin to list of node modules
+
+```shell
+$ yarn add headmin
+```
+## Usage
+Add the Headmin helpers to the Admin helper file
+```ruby
+module AdminHelper
+  include Headmin::AdminHelper
+end
+```
+
+Import the Headmin class into your script. 
+```js
+import {Headmin} from 'headmin'
+
+document.addEventListener("DOMContentLoaded", function () {
+    Headmin.start()
+})
+```
+
+Finally import Headmin in your stylesheet.
+```scss
+@import '~headmin/src/scss/headmin.scss';
+```
+
+## Development
+For development purposes it's helpful to have both the test project and Headmin located in the same directory.
+
+There are 2 ways of working locally:
+1. **Configure package managers (preferred)**: setup bundler and yarn to look for local checkouts 
+2. **Use relative paths**: refer to Headmin by it's relative path
+
+### Solution #1: Configure package managers (preferred)
+This is the preferred way because you can develop locally, and deploy in a staging environment without changing configurations.
+
+Force bundler to use the local gem with:
+```shell
+bundle config local.headmin /usr/local/var/www/headmin
+```
+In your Gemfile you need to refer to the feature branch you're working on
+```ruby
+gem 'headmin', git: 'git@github.com:insiting/headmin.git', branch: 'feature/test'
+```
+
+Symlink the headmin node module like this.
+
+In your Headmin directory:
+```shell
+yarn link
+```
+
+In your project directory
+```shell
+yarn link headmin
+```
+
+### Solution #2: Use relative paths
+We don't prefer this solution because you have to switch sources regularly in Gemfile or package.json for each deployment.
+
+
+In Gemfile
+```ruby
+gem "headmin", path: "../headmin"
+```
+
+In package.json
+```json
+{
+  "dependencies": {
+    "bar": "file:../headmin"
+  }
+}
+```
+
+## Testing
+If you want to test a specific feature in a staging environment without releasing the gem, you can refer to the remote repo in your Gemfile and package.json.
+
+In Gemfile
+```ruby
+gem 'headmin', git: 'git@github.com:insiting/headmin.git', branch: 'feature/test'
+```
+
+In package.json
+```json
+{
+  "dependencies": {
+    "headmin": "ssh://git@github.com:insiting/headmin.git#feature\/test"
+  }
+}
+
+```
+
+## Releasing
+After integration a new feature of fixing a bug, first commit and push your changes.
+
+Build the assets for production
+```shell
+$ nvm use
+$ yarn build 
+```
+
+Update the version number of the gem
+
+```shell
+$ gem bump -v {patch,minor,major,...} -p
+$ gem tag -p
+$ gem release
+```
+
+Use the generated version number for the node module as well
+```
+// In package.json
+
+{
+  "name": "headmin",
+  "version": "{new version number here}",
+  ...
+}
+
+```
+
+## Deployment
+Update the Headmin gem to the latest version
+```shell
+$ bundle update headmin
+```
+
+Update the Headmin node module ot the latest version
+```shell
+$ yarn upgrade headmin
+```
+
+Deploy your app as usual
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/headmin. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/headmin/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Headmin project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/headmin/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/app/controllers/admin/users/confirmations_controller.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Admin::Users::ConfirmationsController < Devise::ConfirmationsController
+  layout 'admin/auth'
+  # GET /resource/confirmation/new
+  # def new
+  #   super
+  # end
+
+  # POST /resource/confirmation
+  # def create
+  #   super
+  # end
+
+  # GET /resource/confirmation?confirmation_token=abcdef
+  # def show
+  #   super
+  # end
+
+  # protected
+
+  # The path used after resending confirmation instructions.
+  # def after_resending_confirmation_instructions_path_for(resource_name)
+  #   super(resource_name)
+  # end
+
+  # The path used after confirmation.
+  # def after_confirmation_path_for(resource_name, resource)
+  #   super(resource_name, resource)
+  # end
+end

data/app/controllers/admin/users/omniauth_callbacks_controller.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Admin::Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+  layout 'admin/auth'
+  # You should configure your model like this:
+  # devise :omniauthable, omniauth_providers: [:twitter]
+
+  # You should also create an action method in this controller like this:
+  # def twitter
+  # end
+
+  # More info at:
+  # https://github.com/heartcombo/devise#omniauth
+
+  # GET|POST /resource/auth/twitter
+  # def passthru
+  #   super
+  # end
+
+  # GET|POST /users/auth/twitter/callback
+  # def failure
+  #   super
+  # end
+
+  # protected
+
+  # The path used when OmniAuth fails
+  # def after_omniauth_failure_path_for(scope)
+  #   super(scope)
+  # end
+end

data/app/controllers/admin/users/passwords_controller.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class Admin::Users::PasswordsController < Devise::PasswordsController
+  layout 'admin/auth'
+  # GET /resource/password/new
+  # def new
+  #   super
+  # end
+
+  # POST /resource/password
+  # def create
+  #   super
+  # end
+
+  # GET /resource/password/edit?reset_password_token=abcdef
+  # def edit
+  #   super
+  # end
+
+  # PUT /resource/password
+  # def update
+  #   super
+  # end
+
+  # protected
+
+  # def after_resetting_password_path_for(resource)
+  #   super(resource)
+  # end
+
+  # The path used after sending reset password instructions
+  # def after_sending_reset_password_instructions_path_for(resource_name)
+  #   super(resource_name)
+  # end
+end

data/app/controllers/admin/users/registrations_controller.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+class Admin::Users::RegistrationsController < Devise::RegistrationsController
+  layout 'admin/auth'
+  # before_action :configure_sign_up_params, only: [:create]
+  # before_action :configure_account_update_params, only: [:update]
+
+  # GET /resource/sign_up
+  # def new
+  #   super
+  # end
+
+  # POST /resource
+  # def create
+  #   super
+  # end
+
+  # GET /resource/edit
+  # def edit
+  #   super
+  # end
+
+  # PUT /resource
+  # def update
+  #   super
+  # end
+
+  # DELETE /resource
+  # def destroy
+  #   super
+  # end
+
+  # GET /resource/cancel
+  # Forces the session data which is usually expired after sign
+  # in to be expired now. This is useful if the user wants to
+  # cancel oauth signing in/up in the middle of the process,
+  # removing all OAuth session data.
+  # def cancel
+  #   super
+  # end
+
+  # protected
+
+  # If you have extra params to permit, append them to the sanitizer.
+  # def configure_sign_up_params
+  #   devise_parameter_sanitizer.permit(:sign_up, keys: [:attribute])
+  # end
+
+  # If you have extra params to permit, append them to the sanitizer.
+  # def configure_account_update_params
+  #   devise_parameter_sanitizer.permit(:account_update, keys: [:attribute])
+  # end
+
+  # The path used after sign up.
+  # def after_sign_up_path_for(resource)
+  #   super(resource)
+  # end
+
+  # The path used after sign up for inactive accounts.
+  # def after_inactive_sign_up_path_for(resource)
+  #   super(resource)
+  # end
+end

data/app/controllers/admin/users/sessions_controller.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class Admin::Users::SessionsController < Devise::SessionsController
+  layout 'admin/auth'
+  # before_action :configure_sign_in_params, only: [:create]
+
+  # GET /resource/sign_in
+  # def new
+  #   super
+  # end
+
+  # POST /resource/sign_in
+  # def create
+  #   super
+  # end
+
+  # DELETE /resource/sign_out
+  # def destroy
+  #   super
+  # end
+
+  # protected
+
+  # If you have extra params to permit, append them to the sanitizer.
+  # def configure_sign_in_params
+  #   devise_parameter_sanitizer.permit(:sign_in, keys: [:attribute])
+  # end
+end

data/app/controllers/admin/users/unlocks_controller.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Admin::Users::UnlocksController < Devise::UnlocksController
+  layout 'admin/auth'
+  # GET /resource/unlock/new
+  # def new
+  #   super
+  # end
+
+  # POST /resource/unlock
+  # def create
+  #   super
+  # end
+
+  # GET /resource/unlock?unlock_token=abcdef
+  # def show
+  #   super
+  # end
+
+  # protected
+
+  # The path used after sending unlock password instructions
+  # def after_sending_unlock_instructions_path_for(resource)
+  #   super(resource)
+  # end
+
+  # The path used after unlocking the resource
+  # def after_unlock_path_for(resource)
+  #   super(resource)
+  # end
+end

data/app/controllers/concerns/headmin/acts_as_list.rb

@@ -0,0 +1,16 @@
+module Headmin
+  module ActsAsList
+    def handle_positions(model:)
+      position_params[:ids].each_with_index do |id, index|
+        model.where(id: id).update_all(position: index + 1)
+      end
+      head :no_content
+    end
+
+    private
+
+    def position_params
+      params.permit(:locale, ids: [])
+    end
+  end
+end

data/app/controllers/concerns/headmin/authentication.rb

@@ -0,0 +1,17 @@
+module Headmin
+  module Authentication
+    extend ActiveSupport::Concern
+
+    included do
+      alias_method :devise_current_user, :current_user
+      before_action :authenticate_admin!
+
+      def current_user
+        devise_current_user || current_admin
+      end
+    end
+
+
+
+  end
+end

data/app/controllers/concerns/headmin/ckeditor.rb

@@ -0,0 +1,27 @@
+module Headmin
+  module Ckeditor
+    def handle_upload
+      blob = ActiveStorage::Blob.create_after_upload!(
+        io: upload_params[:upload],
+        filename: upload_params[:upload].original_filename,
+        content_type: upload_params[:upload].content_type
+      )
+      render json: {
+        urls: {
+          "default": url_for(blob.variant(resize_to_limit: [1600, 1600], quality: 75)),
+          "800": url_for(blob.variant(resize_to_limit: [800, 800], quality: 75)),
+          "1024": url_for(blob.variant(resize_to_limit: [1024, 1024], quality: 75)),
+          "1600": url_for(blob.variant(resize_to_limit: [1600, 1600], quality: 75))
+        }
+      }
+    end
+
+    private
+
+    def upload_params
+      params.permit(
+        :upload, :locale
+      )
+    end
+  end
+end