micro_cms 0.1.0

data/spec/rails_helper.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'spec_helper'
+require 'factory_bot_rails'
+require 'shoulda-matchers'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('dummy/config/environment.rb', __dir__)
+# Prevent database truncation if the environment is production
+abort('The Rails environment is running in production mode!') if Rails.env.production?
+require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Checks for pending migrations and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove these lines.
+begin
+  ActiveRecord::Migration.maintain_test_schema!
+rescue ActiveRecord::PendingMigrationError => e
+  puts e.to_s.strip
+  exit 1
+end
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+
+  config.include FactoryBot::Syntax::Methods
+end
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end

data/spec/requests/micro_cms/content_block_controller_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe MicroCms::ContentBlockController, type: :request do
+  describe '#update' do
+    subject(:request) do
+      put content_block_path(content_block, params: { micro_cms_content_block: params }, format: :js)
+    end
+
+    let!(:content_block) { create :micro_cms_content_block }
+    let(:authorization_token) { 'my-securely-generated-auth-token' }
+
+    before do
+      allow(MicroCms).to receive(:authorization_token).and_return authorization_token
+    end
+
+    context 'when authorization token is correct' do
+      let(:new_content) { 'my new content' }
+      let(:params) do
+        {
+          content: new_content,
+          authorization_token: authorization_token
+        }
+      end
+
+      it 'updates the content block', :aggregate_failures do
+        expect { request }.to change { content_block.reload.content }.from(content_block.content).to(new_content)
+        expect(response).to have_http_status :no_content
+      end
+
+      context 'when the content block cannot be found' do
+        let(:content_block) { build(:micro_cms_content_block, path: 'not-existent') }
+
+        it 'throws not found error' do
+          expect { request }.to raise_error ActiveRecord::RecordNotFound
+        end
+      end
+    end
+
+    context 'when authorization token is incorrect' do
+      let(:evil_content) { 'blubb' }
+
+      let(:params) do
+        {
+          content: evil_content,
+          authorization_token: 'my-evil-spoofing-token'
+        }
+      end
+
+      it 'raises not found error', :aggregate_failures do
+        expect { request }.to raise_exception ActiveRecord::RecordNotFound
+        expect(content_block.reload.content).not_to eq evil_content
+      end
+    end
+  end
+end

data/spec/routing/micro_cms/content_blocks_routing_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe MicroCms::ContentBlockController, type: :routing do
+  routes { MicroCms::Engine.routes }
+
+  describe 'routing' do
+    it 'routes to #update via PUT' do
+      expect(put: '/content_block/1').to route_to('micro_cms/content_block#update', path: '1')
+    end
+
+    it 'routes to #update via PATCH' do
+      expect(patch: '/content_block/1').to route_to('micro_cms/content_block#update', path: '1')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+SimpleCov.start 'rails' do
+  add_filter 'lib/micro_cms/version.rb'
+end
+SimpleCov.minimum_coverage 100
+
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('dummy/config/environment.rb', __dir__)
+
+require 'rspec/rails'
+require 'factory_bot'
+require 'micro_cms'
+require 'capybara/rspec/matchers'
+
+Rails.backtrace_cleaner.remove_silencers!
+ActiveRecord::Migrator.migrations_paths = 'spec/dummy/db/migrate'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching :focus
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+  config.disable_monkey_patching!
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.profile_examples = 10
+  config.order = :random
+  config.include FactoryBot::Syntax::Methods
+  config.include MicroCms::Engine.routes.url_helpers
+  config.include Capybara::RSpecMatchers, type: :view
+
+  Kernel.srand config.seed
+end

data/spec/support/shared_examples/cms_block_helper_spec_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples_for 'creates a new content block at the given path' do
+  it 'creates a new content block at the given path', :aggregate_failures do
+    expect { subject_method }.to change(MicroCms::ContentBlock, :count).by 1
+    expect(content_block.content).to eq content
+    expect(content_block.path).to eq MicroCms::ContentBlock.format_path path
+  end
+end

data/spec/views/micro_cms/content_block_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+RSpec.describe 'micro_cms/_content_block.html.erb', type: :view do
+  let(:content_block) { create :micro_cms_content_block }
+
+  before do
+    render partial: 'micro_cms/content_block', locals: { content_block: content_block }
+  end
+
+  it 'contains the content' do
+    expect(rendered).to include content_block.content
+  end
+
+  it 'contains the contenteditable CMS block' do
+    expect(rendered).to have_selector('div[contenteditable=true]')
+  end
+
+  it 'contains the path as id' do
+    expect(rendered).to have_selector("div[id=\"#{content_block.path}\"]")
+  end
+
+  it 'has a valid update url' do
+    expect(rendered).to have_selector("div[data-update-url=\"#{content_block_path(content_block)}\"]")
+  end
+end

metadata

@@ -0,0 +1,250 @@
+--- !ruby/object:Gem::Specification
+name: micro_cms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lukas Bischof
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !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: Provides a cms block which can be edited inline
+email:
+- lukas.bischof@renuo.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/micro_cms_manifest.js
+- app/assets/javascripts/micro_cms.js
+- app/assets/stylesheets/micro_cms/micro_cms.css
+- app/controllers/micro_cms/application_controller.rb
+- app/controllers/micro_cms/content_block_controller.rb
+- app/helpers/micro_cms/application_helper.rb
+- app/helpers/micro_cms/cms_block_helper.rb
+- app/models/micro_cms/application_record.rb
+- app/models/micro_cms/content_block.rb
+- app/views/micro_cms/_content_block.html.erb
+- config/routes.rb
+- db/migrate/20190923103919_create_micro_cms_content_blocks.rb
+- lib/micro_cms.rb
+- lib/micro_cms/engine.rb
+- lib/micro_cms/version.rb
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/channels/application_cable/channel.rb
+- spec/dummy/app/channels/application_cable/connection.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/javascript/packs/application.js
+- spec/dummy/app/jobs/application_job.rb
+- spec/dummy/app/mailers/application_mailer.rb
+- spec/dummy/app/models/application_record.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/views/layouts/mailer.html.erb
+- spec/dummy/app/views/layouts/mailer.text.erb
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/rspec
+- spec/dummy/bin/setup
+- spec/dummy/bin/spring
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/cable.yml
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/content_security_policy.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/puma.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/config/spring.rb
+- spec/dummy/config/storage.yml
+- spec/dummy/db/development.sqlite3
+- spec/dummy/db/migrate/20190923150252_create_micro_cms_content_blocks.micro_cms.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/apple-touch-icon-precomposed.png
+- spec/dummy/public/apple-touch-icon.png
+- spec/dummy/public/favicon.ico
+- spec/dummy/tmp/development_secret.txt
+- spec/engine/micro_cms_spec.rb
+- spec/examples.txt
+- spec/factories/micro_cms/content_blocks.rb
+- spec/helpers/micro_cms/cms_block_helper_spec.rb
+- spec/models/micro_cms/content_block_spec.rb
+- spec/rails_helper.rb
+- spec/requests/micro_cms/content_block_controller_spec.rb
+- spec/routing/micro_cms/content_blocks_routing_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples/cms_block_helper_spec_helper.rb
+- spec/views/micro_cms/content_block_spec.rb
+homepage: https://github.com/renuo/micro_cms
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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.7.6
+signing_key: 
+specification_version: 4
+summary: An inline micro cms
+test_files:
+- spec/spec_helper.rb
+- spec/dummy/app/mailers/application_mailer.rb
+- spec/dummy/app/models/application_record.rb
+- spec/dummy/app/javascript/packs/application.js
+- spec/dummy/app/jobs/application_job.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/views/layouts/mailer.html.erb
+- spec/dummy/app/views/layouts/mailer.text.erb
+- spec/dummy/app/assets/config/manifest.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/channels/application_cable/connection.rb
+- spec/dummy/app/channels/application_cable/channel.rb
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/bin/rspec
+- spec/dummy/bin/spring
+- spec/dummy/bin/rails
+- spec/dummy/config/routes.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/cable.yml
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/spring.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/storage.yml
+- spec/dummy/config/application.rb
+- spec/dummy/config/puma.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/boot.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/content_security_policy.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config.ru
+- spec/dummy/Rakefile
+- spec/dummy/public/favicon.ico
+- spec/dummy/public/422.html
+- spec/dummy/public/apple-touch-icon.png
+- spec/dummy/public/500.html
+- spec/dummy/public/404.html
+- spec/dummy/public/apple-touch-icon-precomposed.png
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/db/migrate/20190923150252_create_micro_cms_content_blocks.micro_cms.rb
+- spec/dummy/db/development.sqlite3
+- spec/dummy/log/test.log
+- spec/dummy/log/development.log
+- spec/dummy/tmp/development_secret.txt
+- spec/examples.txt
+- spec/models/micro_cms/content_block_spec.rb
+- spec/requests/micro_cms/content_block_controller_spec.rb
+- spec/support/shared_examples/cms_block_helper_spec_helper.rb
+- spec/factories/micro_cms/content_blocks.rb
+- spec/routing/micro_cms/content_blocks_routing_spec.rb
+- spec/views/micro_cms/content_block_spec.rb
+- spec/engine/micro_cms_spec.rb
+- spec/rails_helper.rb
+- spec/helpers/micro_cms/cms_block_helper_spec.rb