├── .document ├── .envrc ├── .github └── workflows │ └── ci.yml ├── .gitignore ├── .rspec ├── .rubocop.yml ├── .rubocop_todo.yml ├── .ruby-version ├── CHANGELOG.md ├── Gemfile ├── Gemfile.lock ├── LICENSE.txt ├── README.md ├── Rakefile ├── app ├── controllers │ └── configurable_engine │ │ ├── application_controller.rb │ │ └── configurables_controller.rb ├── models │ └── configurable.rb └── views │ ├── configurable_engine │ └── configurables │ │ └── show.html.erb │ └── layouts │ └── configurable_engine │ └── application.html.erb ├── config ├── cucumber.yml └── routes.rb ├── configurable_engine.gemspec ├── features ├── configurables.feature ├── step_definitions │ └── web_steps.rb └── support │ ├── env.rb │ └── paths.rb ├── flake.lock ├── flake.nix ├── gemset.nix ├── lib ├── configurable_engine.rb ├── configurable_engine │ ├── configurables_controller_methods.rb │ ├── engine.rb │ └── version.rb └── generators │ └── configurable_engine │ ├── install_generator.rb │ └── templates │ ├── configurable.yml │ └── migration.rb ├── shell.nix └── spec ├── database └── database_sanity_spec.rb ├── dummy ├── .gitignore ├── Rakefile ├── app │ ├── assets │ │ └── config │ │ │ └── manifest.js │ ├── controllers │ │ └── application_controller.rb │ ├── helpers │ │ └── application_helper.rb │ └── views │ │ └── layouts │ │ └── application.html.erb ├── config.ru ├── config │ ├── application.rb │ ├── boot.rb │ ├── configurable.yml │ ├── database.yml │ ├── environment.rb │ ├── environments │ │ ├── development.rb │ │ ├── production.rb │ │ └── test.rb │ ├── initializers │ │ ├── backtrace_silencers.rb │ │ ├── inflections.rb │ │ ├── mime_types.rb │ │ ├── secret_token.rb │ │ └── session_store.rb │ ├── locales │ │ └── en.yml │ └── routes.rb ├── db │ ├── migrate │ │ └── 20110110001344_create_configurables.rb │ ├── schema.rb │ └── seeds.rb ├── lib │ └── tasks │ │ └── .gitkeep ├── public │ ├── 404.html │ ├── 422.html │ ├── 500.html │ ├── favicon.ico │ ├── images │ │ └── rails.png │ ├── index.html │ ├── javascripts │ │ ├── application.js │ │ ├── controls.js │ │ ├── dragdrop.js │ │ ├── effects.js │ │ ├── prototype.js │ │ └── rails.js │ ├── robots.txt │ └── stylesheets │ │ └── .gitkeep ├── script │ └── rails └── vendor │ └── plugins │ └── .gitkeep ├── models └── configurable_spec.rb └── spec_helper.rb /.document: -------------------------------------------------------------------------------- 1 | lib/**/*.rb 2 | bin/* 3 | - 4 | features/**/*.feature 5 | LICENSE.txt 6 | -------------------------------------------------------------------------------- /.envrc: -------------------------------------------------------------------------------- 1 | use flake || use nix 2 | # circumvent https://github.com/direnv/direnv/issues/1345 3 | mkdir -p $TMPDIR 4 | watch_file gemset.nix 5 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: Run tests 2 | on: 3 | pull_request: 4 | branches: 5 | - "master" 6 | push: 7 | branches: 8 | - "master" 9 | 10 | # We also provide a way to run this manually, if needed. 11 | workflow_dispatch: 12 | 13 | jobs: 14 | ci: 15 | runs-on: ubuntu-22.04 16 | steps: 17 | - name: Install Nix 18 | uses: cachix/install-nix-action@v31 19 | with: 20 | github_access_token: ${{ secrets.GITHUB_TOKEN }} 21 | 22 | - name: Check out repository code 23 | uses: actions/checkout@v4 24 | with: 25 | fetch-depth: 0 26 | 27 | - name: Setup dev database 28 | run: nix develop --command rake app:db:schema:load 29 | 30 | - name: Setup test database 31 | run: RAILS_ENV=test nix develop --command rake app:db:test:prepare 32 | 33 | - name: Run tests 34 | run: nix develop --command rake 35 | 36 | - name: Run rubocop 37 | run: nix develop --command rubocop 38 | 39 | - name: Run nix formatter 40 | run: nix fmt -- --check . 41 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # rcov generated 2 | coverage 3 | 4 | # rdoc generated 5 | rdoc 6 | 7 | # yard generated 8 | doc 9 | .yardoc 10 | 11 | # bundler 12 | .bundle 13 | 14 | # jeweler generated 15 | pkg 16 | 17 | # Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 18 | # 19 | # * Create a file at ~/.gitignore 20 | # * Include files you want ignored 21 | # * Run: git config --global core.excludesfile ~/.gitignore 22 | # 23 | # After doing this, these files will be ignored in all your git projects, 24 | # saving you from having to 'pollute' every project you touch with them 25 | # 26 | # Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line) 27 | # 28 | # For MacOS: 29 | # 30 | #.DS_Store 31 | # 32 | # For TextMate 33 | #*.tmproj 34 | #tmtags 35 | # 36 | # For emacs: 37 | #*~ 38 | #\#* 39 | #.\#* 40 | # 41 | # For vim: 42 | #*.swp 43 | .rvmrc 44 | 45 | # for direnv 46 | .direnv 47 | -------------------------------------------------------------------------------- /.rspec: -------------------------------------------------------------------------------- 1 | --color 2 | -------------------------------------------------------------------------------- /.rubocop.yml: -------------------------------------------------------------------------------- 1 | inherit_from: .rubocop_todo.yml 2 | AllCops: 3 | NewCops: enable 4 | SuggestExtensions: 5 | rubocop-rails: false 6 | 7 | plugins: 8 | - rubocop-rspec 9 | 10 | # This prevents us from inlining code, which we think 11 | # is often better then having lots if out-of-order method calls 12 | Metrics/AbcSize: 13 | Enabled: false 14 | 15 | # This prevents us from co-locating functional code, which we think 16 | # is often better then having lots of stateless files. 17 | Metrics/ClassLength: 18 | Enabled: false 19 | 20 | # This prevents us from inlining code, which we think 21 | # is often better then having lots if out-of-order method calls 22 | Metrics/MethodLength: 23 | Enabled: false 24 | 25 | # This prevents us from inlining code, which we think 26 | # is often better then having lots if out-of-order method calls 27 | Metrics/ModuleLength: 28 | Enabled: false 29 | 30 | # This prevents us from inlining which we like. We like inlining! 31 | RSpec/ExampleLength: 32 | Enabled: False 33 | 34 | # We believe that inlining is valuable and expecting one expectation 35 | # forces us to avoid inlining. 36 | RSpec/MultipleExpectations: 37 | Enabled: False 38 | 39 | # explicit makes specs easier to read 40 | RSpec/DescribedClass: 41 | EnforcedStyle: explicit 42 | -------------------------------------------------------------------------------- /.rubocop_todo.yml: -------------------------------------------------------------------------------- 1 | # This configuration was generated by 2 | # `rubocop --auto-gen-config --auto-gen-only-exclude --exclude-limit 1000 --no-auto-gen-timestamp` 3 | # using RuboCop version 1.75.1. 4 | # The point is for the user to remove these configuration records 5 | # one by one as the offenses are removed from the code base. 6 | # Note that changes in the inspected code, or installation of new 7 | # versions of RuboCop, may require this file to be generated again. 8 | 9 | # Offense count: 1 10 | # Configuration parameters: Severity, Include. 11 | # Include: **/*.gemspec 12 | Gemspec/RequiredRubyVersion: 13 | Exclude: 14 | - 'configurable_engine.gemspec' 15 | 16 | # Offense count: 1 17 | # This cop supports safe autocorrection (--autocorrect). 18 | # Configuration parameters: EnforcedStyleAlignWith. 19 | # SupportedStylesAlignWith: either, start_of_block, start_of_line 20 | Layout/BlockAlignment: 21 | Exclude: 22 | - 'lib/configurable_engine/configurables_controller_methods.rb' 23 | 24 | # Offense count: 3 25 | # This cop supports safe autocorrection (--autocorrect). 26 | # Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings. 27 | # URISchemes: http, https 28 | Layout/LineLength: 29 | Exclude: 30 | - 'configurable_engine.gemspec' 31 | - 'spec/dummy/config/initializers/secret_token.rb' 32 | - 'spec/dummy/script/rails' 33 | 34 | # Offense count: 1 35 | # Configuration parameters: DebuggerMethods, DebuggerRequires. 36 | Lint/Debugger: 37 | Exclude: 38 | - 'features/step_definitions/web_steps.rb' 39 | 40 | # Offense count: 1 41 | # Configuration parameters: AllowComments, AllowEmptyLambdas. 42 | Lint/EmptyBlock: 43 | Exclude: 44 | - 'tasks/cucumber.rake' 45 | 46 | # Offense count: 2 47 | # Configuration parameters: AllowedMethods, AllowedPatterns, Max. 48 | Metrics/CyclomaticComplexity: 49 | Exclude: 50 | - 'app/models/configurable.rb' 51 | 52 | # Offense count: 2 53 | # Configuration parameters: AllowedMethods, AllowedPatterns, Max. 54 | Metrics/PerceivedComplexity: 55 | Exclude: 56 | - 'app/models/configurable.rb' 57 | 58 | # Offense count: 1 59 | # Configuration parameters: Prefixes, AllowedPatterns. 60 | # Prefixes: when, with, without 61 | RSpec/ContextWording: 62 | Exclude: 63 | - 'spec/models/configurable_spec.rb' 64 | 65 | # Offense count: 1 66 | # Configuration parameters: IgnoredMetadata. 67 | RSpec/DescribeClass: 68 | Exclude: 69 | - '**/spec/features/**/*' 70 | - '**/spec/requests/**/*' 71 | - '**/spec/routing/**/*' 72 | - '**/spec/system/**/*' 73 | - '**/spec/views/**/*' 74 | - 'spec/database/database_sanity_spec.rb' 75 | 76 | # Offense count: 2 77 | # Configuration parameters: Max, AllowedGroups. 78 | RSpec/NestedGroups: 79 | Exclude: 80 | - 'spec/models/configurable_spec.rb' 81 | 82 | # Offense count: 8 83 | # Configuration parameters: AllowedConstants. 84 | Style/Documentation: 85 | Exclude: 86 | - 'spec/**/*' 87 | - 'test/**/*' 88 | - 'app/controllers/configurable_engine/application_controller.rb' 89 | - 'app/models/configurable.rb' 90 | - 'features/step_definitions/web_steps.rb' 91 | - 'features/support/paths.rb' 92 | - 'lib/configurable_engine/configurables_controller_methods.rb' 93 | - 'lib/configurable_engine/engine.rb' 94 | - 'lib/generators/configurable_engine/install_generator.rb' 95 | - 'lib/generators/configurable_engine/templates/migration.rb' 96 | 97 | # Offense count: 1 98 | Style/MissingRespondToMissing: 99 | Exclude: 100 | - 'app/models/configurable.rb' 101 | 102 | # Offense count: 1 103 | Style/MultilineBlockChain: 104 | Exclude: 105 | - 'lib/configurable_engine/configurables_controller_methods.rb' 106 | -------------------------------------------------------------------------------- /.ruby-version: -------------------------------------------------------------------------------- 1 | 3.2.6 2 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ### v3.0.0 - April 2, 2025 2 | **breaking changes** 3 | Drops support for Rails < 7 and ruby < 3.2 4 | adds support for modern rails 5 | 6 | ### v2.0.2 - August 20, 2020 7 | **bug fixes** 8 | fix rendering with included module 9 | 10 | ### v2.0.1 - August 20, 2020 11 | **bug fixes** 12 | Can render layout of parent application 13 | 14 | ### v2.0.0 - August 20, 2020 15 | **features** 16 | Configurable_Engine is mountable. This allows folks to use it with a catch-all route 17 | 18 | **breaking changes** 19 | Existing users must add `mount ConfigurableEngine::Engine, at: "/admin/configurable"` to their routes.rb. Routing helpers may not work as they used to. 20 | 21 | ### v1.0.0 - August 20, 2020 22 | **features** 23 | Official rails 5.2 support 24 | 25 | **breaking changes** 26 | No further support for rails < 5.2 27 | 28 | ### v0.5.0 - August 3, 2018 29 | **features** 30 | Official rails 4.2 support (Thanks @ento) 31 | 32 | **breaking changes** 33 | No further support for rails < 4.2, and non-mri rubies. Happy to accept those back as PRs! 34 | 35 | 36 | ### v0.4.8 - March 4, 2015 37 | **bug fix** 38 | Cacheing was just totally broken. Whoops! (thanks, @antoshalee) 39 | 40 | ### v0.4.7 - November 4, 2014 41 | **bug fix** 42 | Configurable broke for users using cacheing. 43 | 44 | ### v0.4.6 - October 28, 2014 45 | **cleanup** 46 | When using Configurable with cache, destroying a configurable instance erases it from cache 47 | 48 | ### v0.4.5 - October 13, 2014 49 | **bug fixes** 50 | Configurable can store false values when the default is true (https://github.com/paulca/configurable_engine/pull/24, thanks @lilliealbert) 51 | 52 | ### v0.4.4 - May 21, 2014 53 | **bug fixes** 54 | list types can *actually* deserialize comma delimeted nested and non-nested lists 55 | tested end-to-end but need better specs. sorry about the mess. 56 | 57 | 58 | ### v0.4.3 - May 21, 2014 59 | **bug fixes** 60 | list types can deserialize comma delimeted nested and non-nested lists 61 | 62 | **in other news** 63 | ... time to learn how to release beta versions. If I have to release another fix today, I'll do that. 64 | 65 | ### v0.4.2 - May 21, 2014 66 | **bug fixes** 67 | list types can serialize comma delimeted nested and non-nested lists 68 | 69 | ### v0.4.1 - May 21, 2014 70 | **bug fixes** 71 | if cacheing was enabled, configurable engine would never return default for unset values. 72 | 73 | ### v0.4.0 - May 21, 2014 74 | **features** 75 | Configurable.[]= will serialize arrays set to list-type params. 76 | BREAKING CHANGE: Configurable#value and Configurable.[] should return similarly cast values (previously #value was always the string value) 77 | 78 | ### v0.3.3 - May 21, 2014 79 | **bug fixes** 80 | No longer uses mass assignment internally. 81 | 82 | ### v0.3.2 - Mar 12, 2014 83 | **features** 84 | re-releasing gem without test files included to shrink it. Should have no code changes. 85 | 86 | ### v0.3.1 - Mar 3, 2014 87 | 88 | **features** 89 | - add support for rails 4 and drop support for Rails 3.0 (3.1+) 90 | - add flash notifications for Configurable updates 91 | - added ability to cache configurables 92 | 93 | **bug fixes** 94 | - moved view logic back to the controller 95 | - modernize dependency management 96 | - modernize test suite 97 | - support travis.yml (testing against Ruby 1.9, 2, jruby in 19 mode, rails 3.1, rails 3.2, rails 4) 98 | 99 | ### v0.2.9 - Aug 19, 2011 100 | 101 | **features** 102 | - add validations for keys in configurables 103 | - Assignment of configuration with []= and method missing 104 | - Configurables works if table doesn't exist (returns defaults) 105 | 106 | **bug fixes** 107 | - remove unused dependencies & development dependencies 108 | 109 | ### v0.2.8 - Jul 11, 2011 110 | 111 | **features** 112 | - relax dependencies to allow support for Rails 3.1 113 | 114 | **bug fixes** 115 | - remove unused dependencies 116 | 117 | ### v0.2.6 - Feb 9, 2011 118 | 119 | **features** 120 | - Sort keys alphabetically in the admin 121 | 122 | ### v0.2.5 - Feb 6, 2011 123 | 124 | **bug fixes** 125 | - make dependencies more accurate & less stringent 126 | - dry up admin form 127 | 128 | ### v0.2.1 - Jan 17, 2011 129 | 130 | **features** 131 | - Add checkbox for booleans 132 | - Sort keys 133 | 134 | ### v0.2.0 - Jan 10, 2011 135 | 136 | **features** 137 | - Add support for 'list' type 138 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | source 'https://rubygems.org' 4 | # frozen_string_literal: true 5 | 6 | gemspec 7 | 8 | # dev dependencies 9 | gem 'bundler' 10 | gem 'capybara' 11 | gem 'cucumber-rails', require: false 12 | gem 'database_cleaner' 13 | gem 'pry-byebug' 14 | gem 'rake' 15 | gem 'rspec' 16 | gem 'rspec-collection_matchers' 17 | gem 'rspec-rails' 18 | gem 'rubocop' 19 | gem 'rubocop-rspec' 20 | gem 'sqlite3' 21 | gem 'yard' 22 | -------------------------------------------------------------------------------- /Gemfile.lock: -------------------------------------------------------------------------------- 1 | PATH 2 | remote: . 3 | specs: 4 | configurable_engine (3.0.0) 5 | rails (>= 7.0.0, < 8.0.0) 6 | 7 | GEM 8 | remote: https://rubygems.org/ 9 | specs: 10 | actioncable (7.2.2.1) 11 | actionpack (= 7.2.2.1) 12 | activesupport (= 7.2.2.1) 13 | nio4r (~> 2.0) 14 | websocket-driver (>= 0.6.1) 15 | zeitwerk (~> 2.6) 16 | actionmailbox (7.2.2.1) 17 | actionpack (= 7.2.2.1) 18 | activejob (= 7.2.2.1) 19 | activerecord (= 7.2.2.1) 20 | activestorage (= 7.2.2.1) 21 | activesupport (= 7.2.2.1) 22 | mail (>= 2.8.0) 23 | actionmailer (7.2.2.1) 24 | actionpack (= 7.2.2.1) 25 | actionview (= 7.2.2.1) 26 | activejob (= 7.2.2.1) 27 | activesupport (= 7.2.2.1) 28 | mail (>= 2.8.0) 29 | rails-dom-testing (~> 2.2) 30 | actionpack (7.2.2.1) 31 | actionview (= 7.2.2.1) 32 | activesupport (= 7.2.2.1) 33 | nokogiri (>= 1.8.5) 34 | racc 35 | rack (>= 2.2.4, < 3.2) 36 | rack-session (>= 1.0.1) 37 | rack-test (>= 0.6.3) 38 | rails-dom-testing (~> 2.2) 39 | rails-html-sanitizer (~> 1.6) 40 | useragent (~> 0.16) 41 | actiontext (7.2.2.1) 42 | actionpack (= 7.2.2.1) 43 | activerecord (= 7.2.2.1) 44 | activestorage (= 7.2.2.1) 45 | activesupport (= 7.2.2.1) 46 | globalid (>= 0.6.0) 47 | nokogiri (>= 1.8.5) 48 | actionview (7.2.2.1) 49 | activesupport (= 7.2.2.1) 50 | builder (~> 3.1) 51 | erubi (~> 1.11) 52 | rails-dom-testing (~> 2.2) 53 | rails-html-sanitizer (~> 1.6) 54 | activejob (7.2.2.1) 55 | activesupport (= 7.2.2.1) 56 | globalid (>= 0.3.6) 57 | activemodel (7.2.2.1) 58 | activesupport (= 7.2.2.1) 59 | activerecord (7.2.2.1) 60 | activemodel (= 7.2.2.1) 61 | activesupport (= 7.2.2.1) 62 | timeout (>= 0.4.0) 63 | activestorage (7.2.2.1) 64 | actionpack (= 7.2.2.1) 65 | activejob (= 7.2.2.1) 66 | activerecord (= 7.2.2.1) 67 | activesupport (= 7.2.2.1) 68 | marcel (~> 1.0) 69 | activesupport (7.2.2.1) 70 | base64 71 | benchmark (>= 0.3) 72 | bigdecimal 73 | concurrent-ruby (~> 1.0, >= 1.3.1) 74 | connection_pool (>= 2.2.5) 75 | drb 76 | i18n (>= 1.6, < 2) 77 | logger (>= 1.4.2) 78 | minitest (>= 5.1) 79 | securerandom (>= 0.3) 80 | tzinfo (~> 2.0, >= 2.0.5) 81 | addressable (2.8.7) 82 | public_suffix (>= 2.0.2, < 7.0) 83 | ast (2.4.3) 84 | base64 (0.2.0) 85 | benchmark (0.4.0) 86 | bigdecimal (3.1.9) 87 | builder (3.3.0) 88 | byebug (12.0.0) 89 | capybara (3.40.0) 90 | addressable 91 | matrix 92 | mini_mime (>= 0.1.3) 93 | nokogiri (~> 1.11) 94 | rack (>= 1.6.0) 95 | rack-test (>= 0.6.3) 96 | regexp_parser (>= 1.5, < 3.0) 97 | xpath (~> 3.2) 98 | coderay (1.1.3) 99 | concurrent-ruby (1.3.5) 100 | connection_pool (2.5.0) 101 | crass (1.0.6) 102 | cucumber (9.2.1) 103 | builder (~> 3.2) 104 | cucumber-ci-environment (> 9, < 11) 105 | cucumber-core (> 13, < 14) 106 | cucumber-cucumber-expressions (~> 17.0) 107 | cucumber-gherkin (> 24, < 28) 108 | cucumber-html-formatter (> 20.3, < 22) 109 | cucumber-messages (> 19, < 25) 110 | diff-lcs (~> 1.5) 111 | mini_mime (~> 1.1) 112 | multi_test (~> 1.1) 113 | sys-uname (~> 1.2) 114 | cucumber-ci-environment (10.0.1) 115 | cucumber-core (13.0.3) 116 | cucumber-gherkin (>= 27, < 28) 117 | cucumber-messages (>= 20, < 23) 118 | cucumber-tag-expressions (> 5, < 7) 119 | cucumber-cucumber-expressions (17.1.0) 120 | bigdecimal 121 | cucumber-gherkin (27.0.0) 122 | cucumber-messages (>= 19.1.4, < 23) 123 | cucumber-html-formatter (21.9.0) 124 | cucumber-messages (> 19, < 28) 125 | cucumber-messages (22.0.0) 126 | cucumber-rails (3.1.1) 127 | capybara (>= 3.11, < 4) 128 | cucumber (>= 5, < 10) 129 | railties (>= 5.2, < 9) 130 | cucumber-tag-expressions (6.1.2) 131 | database_cleaner (2.1.0) 132 | database_cleaner-active_record (>= 2, < 3) 133 | database_cleaner-active_record (2.2.0) 134 | activerecord (>= 5.a) 135 | database_cleaner-core (~> 2.0.0) 136 | database_cleaner-core (2.0.1) 137 | date (3.4.1) 138 | diff-lcs (1.6.1) 139 | drb (2.2.1) 140 | erubi (1.13.1) 141 | ffi (1.17.1) 142 | globalid (1.2.1) 143 | activesupport (>= 6.1) 144 | i18n (1.14.7) 145 | concurrent-ruby (~> 1.0) 146 | io-console (0.8.0) 147 | irb (1.15.1) 148 | pp (>= 0.6.0) 149 | rdoc (>= 4.0.0) 150 | reline (>= 0.4.2) 151 | json (2.10.2) 152 | language_server-protocol (3.17.0.4) 153 | lint_roller (1.1.0) 154 | logger (1.7.0) 155 | loofah (2.24.0) 156 | crass (~> 1.0.2) 157 | nokogiri (>= 1.12.0) 158 | mail (2.8.1) 159 | mini_mime (>= 0.1.1) 160 | net-imap 161 | net-pop 162 | net-smtp 163 | marcel (1.0.4) 164 | matrix (0.4.2) 165 | method_source (1.1.0) 166 | mini_mime (1.1.5) 167 | mini_portile2 (2.8.8) 168 | minitest (5.25.5) 169 | multi_test (1.1.0) 170 | net-imap (0.5.6) 171 | date 172 | net-protocol 173 | net-pop (0.1.2) 174 | net-protocol 175 | net-protocol (0.2.2) 176 | timeout 177 | net-smtp (0.5.1) 178 | net-protocol 179 | nio4r (2.7.4) 180 | nokogiri (1.18.7) 181 | mini_portile2 (~> 2.8.2) 182 | racc (~> 1.4) 183 | parallel (1.26.3) 184 | parser (3.3.7.4) 185 | ast (~> 2.4.1) 186 | racc 187 | pp (0.6.2) 188 | prettyprint 189 | prettyprint (0.2.0) 190 | prism (1.4.0) 191 | pry (0.15.2) 192 | coderay (~> 1.1) 193 | method_source (~> 1.0) 194 | pry-byebug (3.11.0) 195 | byebug (~> 12.0) 196 | pry (>= 0.13, < 0.16) 197 | psych (5.2.3) 198 | date 199 | stringio 200 | public_suffix (6.0.1) 201 | racc (1.8.1) 202 | rack (3.1.12) 203 | rack-session (2.1.0) 204 | base64 (>= 0.1.0) 205 | rack (>= 3.0.0) 206 | rack-test (2.2.0) 207 | rack (>= 1.3) 208 | rackup (2.2.1) 209 | rack (>= 3) 210 | rails (7.2.2.1) 211 | actioncable (= 7.2.2.1) 212 | actionmailbox (= 7.2.2.1) 213 | actionmailer (= 7.2.2.1) 214 | actionpack (= 7.2.2.1) 215 | actiontext (= 7.2.2.1) 216 | actionview (= 7.2.2.1) 217 | activejob (= 7.2.2.1) 218 | activemodel (= 7.2.2.1) 219 | activerecord (= 7.2.2.1) 220 | activestorage (= 7.2.2.1) 221 | activesupport (= 7.2.2.1) 222 | bundler (>= 1.15.0) 223 | railties (= 7.2.2.1) 224 | rails-dom-testing (2.2.0) 225 | activesupport (>= 5.0.0) 226 | minitest 227 | nokogiri (>= 1.6) 228 | rails-html-sanitizer (1.6.2) 229 | loofah (~> 2.21) 230 | nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0) 231 | railties (7.2.2.1) 232 | actionpack (= 7.2.2.1) 233 | activesupport (= 7.2.2.1) 234 | irb (~> 1.13) 235 | rackup (>= 1.0.0) 236 | rake (>= 12.2) 237 | thor (~> 1.0, >= 1.2.2) 238 | zeitwerk (~> 2.6) 239 | rainbow (3.1.1) 240 | rake (13.2.1) 241 | rdoc (6.13.1) 242 | psych (>= 4.0.0) 243 | regexp_parser (2.10.0) 244 | reline (0.6.0) 245 | io-console (~> 0.5) 246 | rspec (3.13.0) 247 | rspec-core (~> 3.13.0) 248 | rspec-expectations (~> 3.13.0) 249 | rspec-mocks (~> 3.13.0) 250 | rspec-collection_matchers (1.2.1) 251 | rspec-expectations (>= 2.99.0.beta1) 252 | rspec-core (3.13.3) 253 | rspec-support (~> 3.13.0) 254 | rspec-expectations (3.13.3) 255 | diff-lcs (>= 1.2.0, < 2.0) 256 | rspec-support (~> 3.13.0) 257 | rspec-mocks (3.13.2) 258 | diff-lcs (>= 1.2.0, < 2.0) 259 | rspec-support (~> 3.13.0) 260 | rspec-rails (7.1.1) 261 | actionpack (>= 7.0) 262 | activesupport (>= 7.0) 263 | railties (>= 7.0) 264 | rspec-core (~> 3.13) 265 | rspec-expectations (~> 3.13) 266 | rspec-mocks (~> 3.13) 267 | rspec-support (~> 3.13) 268 | rspec-support (3.13.2) 269 | rubocop (1.75.1) 270 | json (~> 2.3) 271 | language_server-protocol (~> 3.17.0.2) 272 | lint_roller (~> 1.1.0) 273 | parallel (~> 1.10) 274 | parser (>= 3.3.0.2) 275 | rainbow (>= 2.2.2, < 4.0) 276 | regexp_parser (>= 2.9.3, < 3.0) 277 | rubocop-ast (>= 1.43.0, < 2.0) 278 | ruby-progressbar (~> 1.7) 279 | unicode-display_width (>= 2.4.0, < 4.0) 280 | rubocop-ast (1.43.0) 281 | parser (>= 3.3.7.2) 282 | prism (~> 1.4) 283 | rubocop-rspec (3.5.0) 284 | lint_roller (~> 1.1) 285 | rubocop (~> 1.72, >= 1.72.1) 286 | ruby-progressbar (1.13.0) 287 | securerandom (0.4.1) 288 | sqlite3 (2.6.0) 289 | mini_portile2 (~> 2.8.0) 290 | stringio (3.1.6) 291 | sys-uname (1.3.1) 292 | ffi (~> 1.1) 293 | thor (1.3.2) 294 | timeout (0.4.3) 295 | tzinfo (2.0.6) 296 | concurrent-ruby (~> 1.0) 297 | unicode-display_width (3.1.4) 298 | unicode-emoji (~> 4.0, >= 4.0.4) 299 | unicode-emoji (4.0.4) 300 | useragent (0.16.11) 301 | websocket-driver (0.7.7) 302 | base64 303 | websocket-extensions (>= 0.1.0) 304 | websocket-extensions (0.1.5) 305 | xpath (3.2.0) 306 | nokogiri (~> 1.8) 307 | yard (0.9.37) 308 | zeitwerk (2.7.2) 309 | 310 | PLATFORMS 311 | ruby 312 | 313 | DEPENDENCIES 314 | bundler 315 | capybara 316 | configurable_engine! 317 | cucumber-rails 318 | database_cleaner 319 | pry-byebug 320 | rake 321 | rspec 322 | rspec-collection_matchers 323 | rspec-rails 324 | rubocop 325 | rubocop-rspec 326 | sqlite3 327 | yard 328 | 329 | BUNDLED WITH 330 | 2.4.19 331 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Copyright (c) 2011 Paul Campbell 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining 4 | a copy of this software and associated documentation files (the 5 | "Software"), to deal in the Software without restriction, including 6 | without limitation the rights to use, copy, modify, merge, publish, 7 | distribute, sublicense, and/or sell copies of the Software, and to 8 | permit persons to whom the Software is furnished to do so, subject to 9 | the following conditions: 10 | 11 | The above copyright notice and this permission notice shall be 12 | included in all copies or substantial portions of the Software. 13 | 14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 15 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 16 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 17 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 18 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 19 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 20 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Configurable [![Build Status](https://travis-ci.org/paulca/configurable_engine.png?branch=master)](https://travis-ci.org/paulca/configurable_engine) 2 | 3 | A Rails 4 configuration engine. An update to [Behavior](http://github.com/paulca/behavior) for Rails 4. 4 | 5 | ## How it works ## 6 | 7 | Configurable lets you define app-wide configuration variables and values in `config/configurable.yml`. These can then be accessed throughout your app. 8 | 9 | If you or your app users need to change these variables, Configurable stores new values in the database. 10 | 11 | ## Installation ## 12 | 13 | Configurable is available as a Ruby gem. Simply add it to your Rails 4 app's `Gemfile`: 14 | 15 | ```ruby 16 | gem 'configurable_engine' 17 | ``` 18 | 19 | Then run the `configurable_engine:install` generator: 20 | 21 | ```bash 22 | $ rails generate configurable_engine:install 23 | ``` 24 | 25 | this will 26 | - add config/configurable.yml 27 | - create a migration for your configurable table 28 | - mount the UI in your routes (defaulting to admin/configurables) 29 | 30 | 31 | ## Usage ## 32 | 33 | There are two parts to how configurable_engine works. First of all there is a config file, `config/configurable.yml`. This file controls the variables that are allowed to be set in the app. 34 | 35 | For example, if you wanted to have access to a config variable `site_title`, put this in `configurable.yml`: 36 | 37 | ```yaml 38 | site_title: 39 | name: Site Title 40 | default: My Site 41 | # type: String is the default 42 | ``` 43 | Now, within your app, you can access `Configurable[:site_title]` (or `Configurable.site_title` if you prefer). 44 | 45 | Since Configurable is an ActiveRecord model, if you want to update the config, create a Configurable record in the database: 46 | 47 | ```ruby 48 | Configurable.create!(:name => 'site_title', :value => 'My New Site') 49 | ``` 50 | You can set the `type` attribute to `boolean`, `decimal`,`integer`, or `list` and it will treat those fields as those types. Lists are comma and/or newline delimeted arrays of strings. 51 | 52 | ## Web Interface ## 53 | 54 | Configurable comes with a web interface that is available to your app straight away at `http://localhost:3000/admin/configurable`. 55 | 56 | If you want to add a layout, or protect the configurable controller, create `app/controllers/admin/configurables_controller.rb` as such: 57 | 58 | ```bash 59 | $ bundle exec rails generate controller admin/configurables 60 | ``` 61 | 62 | include `ConfigurableEngine::ConfigurablesController`, eg. 63 | 64 | ```ruby 65 | class Admin::ConfigurablesController < ApplicationController 66 | # include the engine controller actions 67 | include ConfigurableEngine::ConfigurablesControllerMethods 68 | 69 | # add your own filter(s) / layout 70 | before_filter :protect_my_code 71 | layout 'admin' 72 | end 73 | ``` 74 | 75 | and replace 76 | ```ruby 77 | route 'mount ConfigurableEngine::Engine, at: "/admin/configurable", as: "configurable"' 78 | ``` 79 | 80 | with 81 | 82 | ```ruby 83 | namespace :admin do 84 | resource :configurable, only: [:show, :update] 85 | end 86 | ``` 87 | 88 | To ensure text areas are rendered correctly, ensure that your layout preserves whitespace. In haml, use the `~` operator 89 | 90 | ```haml 91 | %container 92 | ~ yield 93 | ``` 94 | 95 | If you want to control how the fields in the admin interface appear, you can add additional params in your configurable.yml file: 96 | 97 | ```yaml 98 | site_title: 99 | name: Name of Your Site # sets the edit label 100 | default: My Site # sets the default value 101 | type: string # uses input type="text" 102 | site_description: 103 | name: Describe Your Site # sets the edit label 104 | default: My Site # sets the default value 105 | type: text # uses textarea 106 | secret: 107 | name: A Secret Passphrase # sets the edit label 108 | default: passpass # sets the default value 109 | type: password # uses input type="password" 110 | 111 | Value: 112 | name: A number # sets the edit label 113 | default: 10 # sets the default value 114 | type: integer # coerces the value to an integer 115 | 116 | Price: 117 | name: A price # sets the edit label 118 | default: "10.00" # sets the default value 119 | type: decimal # coerces the value to a decimal 120 | ``` 121 | 122 | ## Caching ## 123 | 124 | If you want to use rails caching of Configurable updates, simply set 125 | 126 | ```ruby 127 | config.use_cache = true 128 | ``` 129 | 130 | in your `config/application.rb` (or `config/production.rb`) 131 | 132 | ## Styling the interface ## 133 | 134 | To style the web interface you are advised to use Sass. Here's an example scss file that will make the interface bootstrap-3 ready: 135 | 136 | ``` 137 | @import 'bootstrap'; 138 | 139 | .configurable-container { 140 | @extend .col-md-6; 141 | 142 | .configurable-options { 143 | form { 144 | @extend .form-horizontal; 145 | 146 | .configurable { 147 | @extend .col-md-12; 148 | @extend .form-group; 149 | 150 | textarea, input[type=text], input[type=password] { 151 | @extend .form-control; 152 | } 153 | } 154 | 155 | input[type=submit] { 156 | @extend .btn; 157 | @extend .btn-primary; 158 | } 159 | } 160 | } 161 | } 162 | ``` 163 | 164 | Just save this into your rails assets and you're ready to go. 165 | 166 | ## Running the Tests ## 167 | 168 | The tests for this rails engine are in the `spec` and `features` directories. They use the dummy rails app in `spec/dummy` 169 | 170 | From the top level run: 171 | 172 | ```bash 173 | $ bundle exec rake app:db:schema:load 174 | $ bundle exec rake app:db:test:prepare 175 | $ bundle exec rake 176 | ``` 177 | 178 | ## Contributing ## 179 | 180 | All contributions are welcome. Just fork the code, ensure your changes include a test, ensure all the current tests pass and send a pull request. 181 | 182 | ## Copyright ## 183 | 184 | Copyright (c) 2011 Paul Campbell. See LICENSE.txt for 185 | further details. 186 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env rake 2 | # frozen_string_literal: true 3 | 4 | begin 5 | require 'bundler/setup' 6 | rescue LoadError 7 | puts 'You must `gem install bundler` and `bundle install` to run rake tasks' 8 | end 9 | 10 | APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__) 11 | load 'rails/tasks/engine.rake' 12 | 13 | Bundler::GemHelper.install_tasks 14 | Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each { |f| load f } 15 | # require 'rspec/core' 16 | require 'rspec/core/rake_task' 17 | 18 | desc 'Run all specs in spec directory (excluding plugin specs)' 19 | RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare') 20 | 21 | task :cucumber do 22 | system('cucumber') 23 | end 24 | 25 | task default: %i[spec cucumber] 26 | -------------------------------------------------------------------------------- /app/controllers/configurable_engine/application_controller.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module ConfigurableEngine 4 | class ApplicationController < ActionController::Base 5 | layout 'configurable_engine/application' 6 | protect_from_forgery with: :exception 7 | end 8 | end 9 | -------------------------------------------------------------------------------- /app/controllers/configurable_engine/configurables_controller.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module ConfigurableEngine 4 | class ConfigurablesController < ::ConfigurableEngine::ApplicationController 5 | include ConfigurableEngine::ConfigurablesControllerMethods 6 | end 7 | end 8 | -------------------------------------------------------------------------------- /app/models/configurable.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | class Configurable < ActiveRecord::Base 4 | after_save :invalidate_cache, if: -> { ConfigurableEngine::Engine.config.use_cache } 5 | after_destroy :invalidate_cache, if: -> { ConfigurableEngine::Engine.config.use_cache } 6 | 7 | validates :name, presence: true, uniqueness: { case_sensitive: true } 8 | 9 | validate :type_of_value 10 | 11 | def self.defaults 12 | @defaults ||= HashWithIndifferentAccess.new( 13 | YAML.load_file( 14 | Rails.root.join('config', 'configurable.yml') 15 | ) 16 | ) 17 | end 18 | 19 | def self.keys 20 | defaults.collect { |k, _v| k.to_s }.sort 21 | end 22 | 23 | def self.[]=(key, value) 24 | exisiting = find_by_name(key) 25 | if exisiting 26 | exisiting.update_attribute(:value, value) 27 | else 28 | create do |c| 29 | c.name = key.to_s 30 | c.value = Configurable.value_for_serialization key, value 31 | end 32 | end 33 | end 34 | 35 | def self.cache_key(key) 36 | "configurable_engine:#{key}" 37 | end 38 | 39 | def self.[](key) 40 | return parse_value key, defaults[key][:default] unless table_exists? 41 | 42 | value = false 43 | found = false 44 | database_finder = lambda do 45 | config = find_by_name(key) 46 | found = !config.nil? 47 | value = config.try(:value) 48 | end 49 | 50 | if ConfigurableEngine::Engine.config.use_cache 51 | found = Rails.cache.exist?(cache_key(key)) 52 | if found 53 | value = Rails.cache.fetch(cache_key(key)) 54 | else 55 | database_finder.call 56 | Rails.cache.write cache_key(key), value if found 57 | end 58 | else 59 | database_finder.call 60 | end 61 | 62 | if found 63 | value 64 | else 65 | parse_value(key, defaults[key][:default]).tap do |val| 66 | Rails.cache.write cache_key(key), val if ConfigurableEngine::Engine.config.use_cache 67 | end 68 | end 69 | end 70 | 71 | def value 72 | self.class.parse_value name, super 73 | end 74 | 75 | def self.parse_value(key, value) 76 | case defaults[key][:type] 77 | when 'boolean' 78 | [true, 1, '1', 't', 'true'].include?(value) 79 | when 'decimal' 80 | value ||= 0 81 | BigDecimal(value.to_s) 82 | when 'integer' 83 | value.to_i 84 | when 'list' 85 | value ||= [] 86 | if value.is_a? Array 87 | value 88 | else 89 | value.split("\n").collect { |v| v =~ /,/ ? v.split(',') : v } 90 | end 91 | when 'date' 92 | if value.is_a? Date 93 | value 94 | elsif value.present? 95 | Date.parse(value) 96 | end 97 | else 98 | value 99 | end 100 | end 101 | 102 | def self.serialized_value(key) 103 | value_for_serialization key, self[key] 104 | end 105 | 106 | def self.value_for_serialization(key, value) 107 | if defaults[key][:type] == 'list' && value.is_a?(Array) 108 | value = value.collect { |entry| entry.join ',' } if value.all? { |entry| entry.is_a? Array } 109 | value.join("\n") 110 | else 111 | value.to_s 112 | end.gsub("\r\n", "\n") 113 | end 114 | 115 | def self.method_missing(name, *args) 116 | name_stripped = name.to_s.sub(/[\?=]$/, '') 117 | if keys.include?(name_stripped) 118 | if name.to_s.end_with?('=') 119 | self[name_stripped] = args.first 120 | else 121 | self[name_stripped] 122 | end 123 | else 124 | super 125 | end 126 | end 127 | 128 | private 129 | 130 | def type_of_value 131 | return unless name 132 | 133 | valid = case Configurable.defaults[name][:type] 134 | when 'boolean' 135 | [true, 1, '1', 'true', false, 0, '0', 'false'].include?(value) 136 | when 'decimal' 137 | begin 138 | BigDecimal(value) 139 | rescue StandardError 140 | false 141 | end 142 | when 'integer' 143 | begin 144 | Integer(value) 145 | rescue StandardError 146 | false 147 | end 148 | when 'list' 149 | value.is_a?(Array) 150 | when 'date' 151 | value.is_a?(Date) 152 | else 153 | true 154 | end 155 | errors.add(:value, I18n.t('activerecord.errors.messages.invalid')) unless valid 156 | end 157 | 158 | def serialize_value 159 | self.value = Configurable.value_for_serialization name, value 160 | end 161 | 162 | def invalidate_cache 163 | Rails.cache.delete(Configurable.cache_key(name)) 164 | end 165 | end 166 | -------------------------------------------------------------------------------- /app/views/configurable_engine/configurables/show.html.erb: -------------------------------------------------------------------------------- 1 |
2 |
3 |

Config

4 |
5 | 6 |
7 | <%= form_tag({}, method: :put) do -%> 8 | <%- @keys.each do |key| -%> 9 | <%- options = Configurable.defaults[key] -%> 10 |
11 | <%= label_tag key, options[:name] %> 12 | <%- if options[:type] == 'boolean' %> 13 | <%= hidden_field_tag key, "0" %> 14 | <%= check_box_tag key, "1", Configurable.send(key) %> 15 | <%- elsif options[:type] == 'password' -%> 16 | <%= password_field_tag key, Configurable.send(key) %> 17 | <%- elsif options[:type] == 'text' -%> 18 | <%= text_area_tag key, Configurable.send(key) %> 19 | <%- elsif options[:type] == 'list' -%> 20 | <%= text_area_tag key, Configurable.serialized_value(key) -%> 21 | <%- else -%> 22 | <%= text_field_tag key, Configurable.send(key) %> 23 | <%- end -%> 24 |
25 | <%- end -%> 26 | 27 | <%= submit_tag 'Save' %> 28 | <%- end -%> 29 |
30 |
31 | -------------------------------------------------------------------------------- /app/views/layouts/configurable_engine/application.html.erb: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Configurable engine 5 | <%= csrf_meta_tags %> 6 | <%= csp_meta_tag %> 7 | 8 | 9 | 10 | <%= yield %> 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /config/cucumber.yml: -------------------------------------------------------------------------------- 1 | <% 2 | rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : "" 3 | rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}" 4 | std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} --strict --tags 'not @wip'" 5 | %> 6 | default: <%= std_opts %> features 7 | wip: --tags @wip:3 --wip features 8 | rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags 'not @wip' 9 | -------------------------------------------------------------------------------- /config/routes.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | ConfigurableEngine::Engine.routes.draw do 4 | resource :configurable, path: '/', only: %i[show update] 5 | end 6 | -------------------------------------------------------------------------------- /configurable_engine.gemspec: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | lib = File.expand_path('lib', __dir__) 4 | $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) 5 | require 'configurable_engine/version' 6 | 7 | Gem::Specification.new do |spec| 8 | spec.name = 'configurable_engine' 9 | spec.version = ConfigurableEngine::VERSION 10 | 11 | spec.authors = ['Paul Campbell', 'Michael Glass'] 12 | spec.description = 'Configurable is a Rails 4 engine that allows you to set up config variables in a config file, specifying default values for all environmentspec. These variables can then be set on a per-app basis using a user facing configuration screen. ' 13 | spec.email = 'paul@rslw.com' 14 | spec.extra_rdoc_files = [ 15 | 'LICENSE.txt', 16 | 'README.md' 17 | ] 18 | 19 | spec.files = Dir['*.txt', '*.md', 'lib/**/*', 'app/**/*', 'config/**/*'] - ['config/cucumber.yml'] 20 | 21 | spec.homepage = 'http://github.com/paulca/configurable_engine' 22 | spec.licenses = ['MIT'] 23 | spec.require_paths = ['lib'] 24 | spec.summary = 'Database-backed configuration for Rails 7, with defaults from config file.' 25 | 26 | spec.add_dependency 'rails', '>=7.0.0', '<8.0.0' 27 | spec.metadata['rubygems_mfa_required'] = 'true' 28 | end 29 | -------------------------------------------------------------------------------- /features/configurables.feature: -------------------------------------------------------------------------------- 1 | Feature: Configurables 2 | In order to change configurable options on the site 3 | As an admin 4 | I want to be able to change them 5 | 6 | Scenario: Editing Config 7 | When I am on the config page 8 | And I fill in "Notify Email" with "paul@rslw.com" 9 | And I press "Save" 10 | Then the "Notify Email" field should contain "paul@rslw.com" 11 | -------------------------------------------------------------------------------- /features/step_definitions/web_steps.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | # IMPORTANT: This file is generated by cucumber-rails - edit at your own peril. 4 | # It is recommended to regenerate this file in the future when you upgrade to a 5 | # newer version of cucumber-rails. Consider adding your own code to a new file 6 | # instead of editing this one. Cucumber will automatically load all features/**/*.rb 7 | # files. 8 | 9 | require 'uri' 10 | require 'cgi' 11 | require File.expand_path(File.join(File.dirname(__FILE__), '..', 'support', 'paths')) 12 | 13 | module WithinHelpers 14 | def with_scope(locator, &) 15 | locator ? within(locator, &) : yield 16 | end 17 | end 18 | World(WithinHelpers) 19 | 20 | Given(/^(?:|I )am on (.+)$/) do |page_name| 21 | visit path_to(page_name) 22 | end 23 | 24 | When(/^(?:|I )go to (.+)$/) do |page_name| 25 | visit path_to(page_name) 26 | end 27 | 28 | When(/^(?:|I )press "([^"]*)"(?: within "([^"]*)")?$/) do |button, selector| 29 | with_scope(selector) do 30 | click_button(button) 31 | end 32 | end 33 | 34 | When(/^(?:|I )follow "([^"]*)"(?: within "([^"]*)")?$/) do |link, selector| 35 | with_scope(selector) do 36 | click_link(link) 37 | end 38 | end 39 | 40 | When(/^(?:|I )fill in "([^"]*)" with "([^"]*)"(?: within "([^"]*)")?$/) do |field, value, selector| 41 | with_scope(selector) do 42 | fill_in(field, with: value) 43 | end 44 | end 45 | 46 | When(/^(?:|I )fill in "([^"]*)" for "([^"]*)"(?: within "([^"]*)")?$/) do |value, field, selector| 47 | with_scope(selector) do 48 | fill_in(field, with: value) 49 | end 50 | end 51 | 52 | # Use this to fill in an entire form with data from a table. Example: 53 | # 54 | # When I fill in the following: 55 | # | Account Number | 5002 | 56 | # | Expiry date | 2009-11-01 | 57 | # | Note | Nice guy | 58 | # | Wants Email? | | 59 | # 60 | # TODO: Add support for checkbox, select og option 61 | # based on naming conventions. 62 | # 63 | When(/^(?:|I )fill in the following(?: within "([^"]*)")?:$/) do |selector, fields| 64 | with_scope(selector) do 65 | fields.rows_hash.each do |name, value| 66 | When %(I fill in "#{name}" with "#{value}") 67 | end 68 | end 69 | end 70 | 71 | When(/^(?:|I )select "([^"]*)" from "([^"]*)"(?: within "([^"]*)")?$/) do |value, field, selector| 72 | with_scope(selector) do 73 | select(value, from: field) 74 | end 75 | end 76 | 77 | When(/^(?:|I )check "([^"]*)"(?: within "([^"]*)")?$/) do |field, selector| 78 | with_scope(selector) do 79 | check(field) 80 | end 81 | end 82 | 83 | When(/^(?:|I )uncheck "([^"]*)"(?: within "([^"]*)")?$/) do |field, selector| 84 | with_scope(selector) do 85 | uncheck(field) 86 | end 87 | end 88 | 89 | When(/^(?:|I )choose "([^"]*)"(?: within "([^"]*)")?$/) do |field, selector| 90 | with_scope(selector) do 91 | choose(field) 92 | end 93 | end 94 | 95 | When(/^(?:|I )attach the file "([^"]*)" to "([^"]*)"(?: within "([^"]*)")?$/) do |path, field, selector| 96 | with_scope(selector) do 97 | attach_file(field, path) 98 | end 99 | end 100 | 101 | Then(/^(?:|I )should see JSON:$/) do |expected_json| 102 | require 'json' 103 | expected = JSON.pretty_generate(JSON.parse(expected_json)) 104 | actual = JSON.pretty_generate(JSON.parse(response.body)) 105 | expected.should == actual 106 | end 107 | 108 | Then(/^(?:|I )should see "([^"]*)"(?: within "([^"]*)")?$/) do |text, selector| 109 | with_scope(selector) do 110 | if page.respond_to? :should 111 | page.should have_content(text) 112 | else 113 | assert page.has_content?(text) 114 | end 115 | end 116 | end 117 | 118 | Then(%r{^(?:|I )should see /([^/]*)/(?: within "([^"]*)")?$}) do |regexp, selector| 119 | regexp = Regexp.new(regexp) 120 | with_scope(selector) do 121 | if page.respond_to? :should 122 | page.should have_xpath('//*', text: regexp) 123 | else 124 | assert page.has_xpath?('//*', text: regexp) 125 | end 126 | end 127 | end 128 | 129 | Then(/^(?:|I )should not see "([^"]*)"(?: within "([^"]*)")?$/) do |text, selector| 130 | with_scope(selector) do 131 | if page.respond_to? :should 132 | page.should have_no_content(text) 133 | else 134 | assert page.has_no_content?(text) 135 | end 136 | end 137 | end 138 | 139 | Then(%r{^(?:|I )should not see /([^/]*)/(?: within "([^"]*)")?$}) do |regexp, selector| 140 | regexp = Regexp.new(regexp) 141 | with_scope(selector) do 142 | if page.respond_to? :should 143 | page.should have_no_xpath('//*', text: regexp) 144 | else 145 | assert page.has_no_xpath?('//*', text: regexp) 146 | end 147 | end 148 | end 149 | 150 | Then(/^the "([^"]*)" field(?: within "([^"]*)")? should contain "([^"]*)"$/) do |field, selector, value| 151 | with_scope(selector) do 152 | field = find_field(field) 153 | field_value = field.tag_name == 'textarea' ? field.text : field.value 154 | if field_value.respond_to? :should 155 | expect(field_value).to match(/#{value}/) 156 | else 157 | assert_match(/#{value}/, field_value) 158 | end 159 | end 160 | end 161 | 162 | Then(/^the "([^"]*)" field(?: within "([^"]*)")? should not contain "([^"]*)"$/) do |field, selector, value| 163 | with_scope(selector) do 164 | field = find_field(field) 165 | field_value = field.tag_name == 'textarea' ? field.text : field.value 166 | if field_value.respond_to? :should_not 167 | field_value.should_not =~ /#{value}/ 168 | else 169 | assert_no_match(/#{value}/, field_value) 170 | end 171 | end 172 | end 173 | 174 | Then(/^the "([^"]*)" checkbox(?: within "([^"]*)")? should be checked$/) do |label, selector| 175 | with_scope(selector) do 176 | field_checked = find_field(label)['checked'] 177 | if field_checked.respond_to? :should 178 | field_checked.should be_true 179 | else 180 | assert field_checked 181 | end 182 | end 183 | end 184 | 185 | Then(/^the "([^"]*)" checkbox(?: within "([^"]*)")? should not be checked$/) do |label, selector| 186 | with_scope(selector) do 187 | field_checked = find_field(label)['checked'] 188 | if field_checked.respond_to? :should 189 | field_checked.should be_false 190 | else 191 | assert !field_checked 192 | end 193 | end 194 | end 195 | 196 | Then(/^(?:|I )should be on (.+)$/) do |page_name| 197 | current_path = URI.parse(current_url).path 198 | if current_path.respond_to? :should 199 | current_path.should == path_to(page_name) 200 | else 201 | assert_equal path_to(page_name), current_path 202 | end 203 | end 204 | 205 | Then(/^(?:|I )should have the following query string:$/) do |expected_pairs| 206 | query = URI.parse(current_url).query 207 | actual_params = query ? CGI.parse(query) : {} 208 | expected_params = {} 209 | expected_pairs.rows_hash.each_pair { |k, v| expected_params[k] = v.split(',') } 210 | 211 | if actual_params.respond_to? :should 212 | actual_params.should == expected_params 213 | else 214 | assert_equal expected_params, actual_params 215 | end 216 | end 217 | 218 | Then(/^show me the page$/) do 219 | save_and_open_page 220 | end 221 | -------------------------------------------------------------------------------- /features/support/env.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | ENV['RAILS_ENV'] ||= 'test' 4 | dummy_path = File.expand_path('../../spec/dummy', __dir__) 5 | require File.join(dummy_path, 'config', 'environment') 6 | ENV['RAILS_ROOT'] ||= dummy_path 7 | 8 | require 'cucumber/rails' 9 | 10 | # Capybara defaults to XPath selectors rather than Webrat's default of CSS3. In 11 | # order to ease the transition to Capybara we set the default here. If you'd 12 | # prefer to use XPath just remove this line and adjust any selectors in your 13 | # steps to use the XPath syntax. 14 | Capybara.default_selector = :css 15 | 16 | # By default, any exception happening in your Rails application will bubble up 17 | # to Cucumber so that your scenario will fail. This is a different from how 18 | # your application behaves in the production environment, where an error page will 19 | # be rendered instead. 20 | # 21 | # Sometimes we want to override this default behaviour and allow Rails to rescue 22 | # exceptions and display an error page (just like when the app is running in production). 23 | # Typical scenarios where you want to do this is when you test your error pages. 24 | # There are two ways to allow Rails to rescue exceptions: 25 | # 26 | # 1) Tag your scenario (or feature) with @allow-rescue 27 | # 28 | # 2) Set the value below to true. Beware that doing this globally is not 29 | # recommended as it will mask a lot of errors for you! 30 | # 31 | ActionController::Base.allow_rescue = false 32 | 33 | # Remove/comment out the lines below if your app doesn't have a database. 34 | # For some databases (like MongoDB and CouchDB) you may need to use :truncation instead. 35 | begin 36 | DatabaseCleaner.strategy = :transaction 37 | rescue NameError 38 | raise 'You need to add database_cleaner to your Gemfile (in the :test group) if you wish to use it.' 39 | end 40 | 41 | # You may also want to configure DatabaseCleaner to use different strategies for certain features and scenarios. 42 | # See the DatabaseCleaner documentation for details. Example: 43 | # 44 | # Before('@no-txn,@selenium,@culerity,@celerity,@javascript') do 45 | # # { :except => [:widgets] } may not do what you expect here 46 | # # as Cucumber::Rails::Database.javascript_strategy overrides 47 | # # this setting. 48 | # DatabaseCleaner.strategy = :truncation 49 | # end 50 | # 51 | # Before('~@no-txn', '~@selenium', '~@culerity', '~@celerity', '~@javascript') do 52 | # DatabaseCleaner.strategy = :transaction 53 | # end 54 | # 55 | 56 | # Possible values are :truncation and :transaction 57 | # The :transaction strategy is faster, but might give you threading problems. 58 | # See https://github.com/cucumber/cucumber-rails/blob/master/features/choose_javascript_database_strategy.feature 59 | Cucumber::Rails::Database.javascript_strategy = :truncation 60 | -------------------------------------------------------------------------------- /features/support/paths.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module NavigationHelpers 4 | # Maps a name to a path. Used by the 5 | # 6 | # When /^I go to (.+)$/ do |page_name| 7 | # 8 | # step definition in web_steps.rb 9 | # 10 | def path_to(page_name) 11 | case page_name 12 | 13 | when /the home\s?page/ 14 | '/' 15 | when /the config page/ 16 | ConfigurableEngine::Engine.routes.url_helpers.configurable_path 17 | 18 | # Add more mappings here. 19 | # Here is an example that pulls values out of the Regexp: 20 | # 21 | # when /^(.*)'s profile page$/i 22 | # user_profile_path(User.find_by_login($1)) 23 | 24 | else 25 | begin 26 | page_name =~ /the (.*) page/ 27 | path_components = ::Regexp.last_match(1).split(/\s+/) 28 | send(path_components.push('path').join('_').to_sym) 29 | rescue Object 30 | raise "Can't find mapping from \"#{page_name}\" to a path.\n" \ 31 | "Now, go and add a mapping in #{__FILE__}" 32 | end 33 | end 34 | end 35 | end 36 | 37 | World(NavigationHelpers) 38 | -------------------------------------------------------------------------------- /flake.lock: -------------------------------------------------------------------------------- 1 | { 2 | "nodes": { 3 | "bundix": { 4 | "inputs": { 5 | "nixpkgs": [ 6 | "nixpkgs" 7 | ] 8 | }, 9 | "locked": { 10 | "lastModified": 1721093334, 11 | "narHash": "sha256-5FghZ0HIETbc0TGcBV8uyixq5z4w/9PF5Puhujz3D1o=", 12 | "owner": "inscapist", 13 | "repo": "bundix", 14 | "rev": "42c08846f7e5d91ef121239fd364feaeb22c0bbc", 15 | "type": "github" 16 | }, 17 | "original": { 18 | "owner": "inscapist", 19 | "ref": "main", 20 | "repo": "bundix", 21 | "type": "github" 22 | } 23 | }, 24 | "fu": { 25 | "inputs": { 26 | "systems": "systems" 27 | }, 28 | "locked": { 29 | "lastModified": 1731533236, 30 | "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=", 31 | "owner": "numtide", 32 | "repo": "flake-utils", 33 | "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b", 34 | "type": "github" 35 | }, 36 | "original": { 37 | "owner": "numtide", 38 | "repo": "flake-utils", 39 | "type": "github" 40 | } 41 | }, 42 | "nixpkgs": { 43 | "locked": { 44 | "lastModified": 1743501102, 45 | "narHash": "sha256-7PCBQ4aGVF8OrzMkzqtYSKyoQuU2jtpPi4lmABpe5X4=", 46 | "owner": "nixos", 47 | "repo": "nixpkgs", 48 | "rev": "02f2af8c8a8c3b2c05028936a1e84daefa1171d4", 49 | "type": "github" 50 | }, 51 | "original": { 52 | "owner": "nixos", 53 | "ref": "nixos-24.11", 54 | "repo": "nixpkgs", 55 | "type": "github" 56 | } 57 | }, 58 | "nixpkgs_2": { 59 | "locked": { 60 | "lastModified": 1678875422, 61 | "narHash": "sha256-T3o6NcQPwXjxJMn2shz86Chch4ljXgZn746c2caGxd8=", 62 | "owner": "NixOS", 63 | "repo": "nixpkgs", 64 | "rev": "126f49a01de5b7e35a43fd43f891ecf6d3a51459", 65 | "type": "github" 66 | }, 67 | "original": { 68 | "id": "nixpkgs", 69 | "type": "indirect" 70 | } 71 | }, 72 | "root": { 73 | "inputs": { 74 | "bundix": "bundix", 75 | "fu": "fu", 76 | "nixpkgs": "nixpkgs", 77 | "ruby-nix": "ruby-nix" 78 | } 79 | }, 80 | "ruby-nix": { 81 | "inputs": { 82 | "nixpkgs": "nixpkgs_2" 83 | }, 84 | "locked": { 85 | "lastModified": 1725677741, 86 | "narHash": "sha256-CySXGzqycagfrWdcTwzM3Zo1MMm9uUtePYER9BvrW8s=", 87 | "owner": "inscapist", 88 | "repo": "ruby-nix", 89 | "rev": "1f3756f8a713171bf891b39c0d3b1fe6d83a4a63", 90 | "type": "github" 91 | }, 92 | "original": { 93 | "owner": "inscapist", 94 | "repo": "ruby-nix", 95 | "type": "github" 96 | } 97 | }, 98 | "systems": { 99 | "locked": { 100 | "lastModified": 1681028828, 101 | "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", 102 | "owner": "nix-systems", 103 | "repo": "default", 104 | "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", 105 | "type": "github" 106 | }, 107 | "original": { 108 | "owner": "nix-systems", 109 | "repo": "default", 110 | "type": "github" 111 | } 112 | } 113 | }, 114 | "root": "root", 115 | "version": 7 116 | } 117 | -------------------------------------------------------------------------------- /flake.nix: -------------------------------------------------------------------------------- 1 | { 2 | description = "dev env for configurable engine"; 3 | 4 | nixConfig = { 5 | extra-substituters = "https://nixpkgs-ruby.cachix.org"; 6 | extra-trusted-public-keys = "nixpkgs-ruby.cachix.org-1:vrcdi50fTolOxWCZZkw0jakOnUI1T19oYJ+PRYdK4SM="; 7 | }; 8 | 9 | inputs = { 10 | nixpkgs.url = "github:nixos/nixpkgs/nixos-24.11"; 11 | ruby-nix.url = "github:inscapist/ruby-nix"; 12 | # a fork that supports platform dependant gem 13 | bundix = { 14 | url = "github:inscapist/bundix/main"; 15 | inputs.nixpkgs.follows = "nixpkgs"; 16 | }; 17 | fu.url = "github:numtide/flake-utils"; 18 | }; 19 | 20 | outputs = 21 | { 22 | self, 23 | nixpkgs, 24 | fu, 25 | ruby-nix, 26 | bundix, 27 | }: 28 | with fu.lib; 29 | eachDefaultSystem ( 30 | system: 31 | let 32 | 33 | assertVersion = 34 | version: pkg: 35 | ( 36 | assert ( 37 | pkgs.lib.assertMsg (builtins.toString pkg.version == version) '' 38 | Expecting version of ${pkg.name} to be ${version} but got ${pkg.version}; 39 | '' 40 | ); 41 | pkg 42 | ); 43 | 44 | pkgs = import nixpkgs { inherit system; }; 45 | rubyNix = ruby-nix.lib pkgs; 46 | 47 | gemset = if builtins.pathExists ./gemset.nix then import ./gemset.nix else { }; 48 | 49 | # If you want to override gem build config, see 50 | # https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/ruby-modules/gem-config/default.nix 51 | gemConfig = { }; 52 | 53 | ruby = (assertVersion (pkgs.lib.strings.fileContents "${self}/.ruby-version") pkgs.ruby_3_2); 54 | 55 | # Running bundix regenerate `gemset.nix` 56 | bundixcli = bundix.packages.${system}.default; 57 | 58 | # Use these instead of the original `bundle ` commands 59 | bundleLock = pkgs.writeShellScriptBin "bundle-lock" '' 60 | export BUNDLE_PATH=vendor/bundle 61 | bundle lock 62 | ''; 63 | bundleUpdate = pkgs.writeShellScriptBin "bundle-update" '' 64 | export BUNDLE_PATH=vendor/bundle 65 | bundle lock --update 66 | ''; 67 | in 68 | rec { 69 | inherit 70 | (rubyNix { 71 | inherit gemset ruby; 72 | name = "configurable engine"; 73 | gemConfig = pkgs.defaultGemConfig // gemConfig; 74 | }) 75 | env 76 | ; 77 | 78 | formatter = pkgs.nixfmt-rfc-style; 79 | devShells = rec { 80 | default = dev; 81 | dev = pkgs.mkShell { 82 | buildInputs = ( 83 | (with pkgs; [ sqlite ]) 84 | ++ [ 85 | env 86 | bundixcli 87 | bundleLock 88 | bundleUpdate 89 | ] 90 | ); 91 | }; 92 | }; 93 | } 94 | ); 95 | } 96 | -------------------------------------------------------------------------------- /lib/configurable_engine.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | require 'configurable_engine/engine' 4 | require 'configurable_engine/configurables_controller_methods' 5 | -------------------------------------------------------------------------------- /lib/configurable_engine/configurables_controller_methods.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module ConfigurableEngine 4 | module ConfigurablesControllerMethods 5 | def show 6 | @keys = Configurable.keys 7 | render 'configurable_engine/configurables/show' 8 | end 9 | 10 | def update 11 | failures = Configurable 12 | .keys.map do |key| 13 | Configurable.find_by_name(key) || 14 | Configurable.create { |c| c.name = key } 15 | end.reject do |configurable| 16 | configurable.value = params[configurable.name] 17 | configurable.save 18 | end 19 | 20 | if failures.empty? 21 | redirect_to(action: :show, notice: 'Changes successfully updated') 22 | else 23 | flash[:error] = failures.flat_map(&:errors).flat_map(&:full_messages).join(',') 24 | redirect_to(action: :show) 25 | end 26 | end 27 | end 28 | end 29 | -------------------------------------------------------------------------------- /lib/configurable_engine/engine.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module ConfigurableEngine 4 | class Engine < ::Rails::Engine 5 | engine_name 'configurable' 6 | isolate_namespace ConfigurableEngine 7 | config.use_cache = false 8 | config.generators do |g| 9 | g.test_framework :rspec 10 | end 11 | end 12 | end 13 | -------------------------------------------------------------------------------- /lib/configurable_engine/version.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module ConfigurableEngine 4 | VERSION = '3.0.0' 5 | end 6 | -------------------------------------------------------------------------------- /lib/generators/configurable_engine/install_generator.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | require 'rails/generators' 4 | module ConfigurableEngine 5 | class InstallGenerator < Rails::Generators::Base 6 | include Rails::Generators::Migration 7 | 8 | def self.source_root 9 | @source_root ||= File.join(File.dirname(__FILE__), 'templates') 10 | end 11 | 12 | def self.next_migration_number(dirname) 13 | if ActiveRecord::Base.timestamped_migrations 14 | Time.now.utc.strftime('%Y%m%d%H%M%S') 15 | else 16 | format('%.3d', (current_migration_number(dirname) + 1)) 17 | end 18 | end 19 | 20 | def create_migration_file 21 | copy_file 'configurable.yml', 'config/configurable.yml' 22 | migration_template 'migration.rb', 'db/migrate/create_configurables.rb' 23 | end 24 | 25 | def mount_interface 26 | route 'mount ConfigurableEngine::Engine, at: "/admin/configurable", as: "configurable"' 27 | end 28 | end 29 | end 30 | -------------------------------------------------------------------------------- /lib/generators/configurable_engine/templates/configurable.yml: -------------------------------------------------------------------------------- 1 | # This file controls what config variables you want to be able to allow your users 2 | # to set, as well as those you'll be able to access from within the application. 3 | # 4 | # If you want to be able to access a string config[:site_title], for example: 5 | # 6 | # site_title: 7 | # name: Site Title 8 | # type: string 9 | # default: My Site 10 | # 11 | # 'name' is the name that appears in the edit form 12 | # 13 | # 'type' can be 'string' for a text field, 'password' for a password field or 'text' for a text area 14 | # 'type' defaults to 'string' 15 | # 16 | # 'default' is the default value to use if there's no entry in the database. Otherwise, nil will be returned 17 | # 18 | # Some Examples: 19 | # 20 | # site_title: 21 | # name: Site Title 22 | # default: My Site 23 | # type: string 24 | # 25 | # site_description: 26 | # name: Description for Google 27 | # default: Lots of Awesomeness Here 28 | # type: text 29 | # 30 | # secret: 31 | # name: Secret Password for Accessing Secret Areas 32 | # default: secret 33 | # type: password -------------------------------------------------------------------------------- /lib/generators/configurable_engine/templates/migration.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | class CreateConfigurables < ActiveRecord::Migration[5.2] 4 | def self.up 5 | create_table :configurables do |t| 6 | t.string :name 7 | t.string :value 8 | 9 | t.timestamps 10 | end 11 | 12 | add_index :configurables, :name 13 | end 14 | 15 | def self.down 16 | remove_index :configurables, :name 17 | drop_table :configurables 18 | end 19 | end 20 | -------------------------------------------------------------------------------- /shell.nix: -------------------------------------------------------------------------------- 1 | (import (fetchTarball "https://github.com/edolstra/flake-compat/archive/master.tar.gz") { 2 | src = builtins.fetchGit ./.; 3 | }).shellNix 4 | -------------------------------------------------------------------------------- /spec/database/database_sanity_spec.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | describe 'dummy app database configuration' do 4 | it 'ensures that the development and test databases are in different locations' do 5 | configs = ActiveRecord::Base.configurations 6 | dev_db = configs.find_db_config('development').database 7 | test_db = configs.find_db_config('test').database 8 | 9 | expect(dev_db).to match(/development/) 10 | expect(test_db).to match(/test/) 11 | expect(dev_db).not_to eq test_db 12 | end 13 | end 14 | -------------------------------------------------------------------------------- /spec/dummy/.gitignore: -------------------------------------------------------------------------------- 1 | .bundle 2 | db/*.sqlite3 3 | log/*.log 4 | tmp/**/* 5 | -------------------------------------------------------------------------------- /spec/dummy/Rakefile: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | # Add your own tasks in files placed in lib/tasks ending in .rake, 4 | # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake. 5 | 6 | require File.expand_path('config/application', __dir__) 7 | require 'rake' 8 | 9 | Dummy::Application.load_tasks 10 | -------------------------------------------------------------------------------- /spec/dummy/app/assets/config/manifest.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/paulca/configurable_engine/5f7829bfbea5700f69d8c13bc795093d6db20fd9/spec/dummy/app/assets/config/manifest.js -------------------------------------------------------------------------------- /spec/dummy/app/controllers/application_controller.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | class ApplicationController < ActionController::Base 4 | protect_from_forgery 5 | end 6 | -------------------------------------------------------------------------------- /spec/dummy/app/helpers/application_helper.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module ApplicationHelper 4 | end 5 | -------------------------------------------------------------------------------- /spec/dummy/app/views/layouts/application.html.erb: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Dummy 5 | <%= csrf_meta_tag %> 6 | 7 | 8 | 9 | <%= yield %> 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /spec/dummy/config.ru: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | # This file is used by Rack-based servers to start the application. 4 | 5 | require File.expand_path('config/environment', __dir__) 6 | run Dummy::Application 7 | -------------------------------------------------------------------------------- /spec/dummy/config/application.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | require File.expand_path('boot', __dir__) 4 | 5 | require 'rails/all' 6 | 7 | # If you have a Gemfile, require the gems listed there, including any gems 8 | # you've limited to :test, :development, or :production. 9 | Bundler.require(:default, Rails.env) if defined?(Bundler) 10 | $LOAD_PATH.unshift File.expand_path('../../../lib', __dir__) 11 | require 'configurable_engine' 12 | 13 | module Dummy 14 | class Application < Rails::Application 15 | # Settings in config/environments/* take precedence over those specified here. 16 | # Application configuration should go into files in config/initializers 17 | # -- all .rb files in that directory are automatically loaded. 18 | 19 | # Custom directories with classes and modules you want to be autoloadable. 20 | # config.autoload_paths += %W(#{config.root}/extras) 21 | 22 | # Only load the plugins named here, in the order given (default is alphabetical). 23 | # :all can be used as a placeholder for all plugins not explicitly named. 24 | # config.plugins = [ :exception_notification, :ssl_requirement, :all ] 25 | 26 | # Activate observers that should always be running. 27 | # config.active_record.observers = :cacher, :garbage_collector, :forum_observer 28 | 29 | # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone. 30 | # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC. 31 | # config.time_zone = 'Central Time (US & Canada)' 32 | 33 | # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded. 34 | # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s] 35 | # config.i18n.default_locale = :de 36 | config.i18n.enforce_available_locales = true 37 | 38 | config.load_defaults 5.2 39 | 40 | # JavaScript files you want as :defaults (application.js is always included). 41 | # config.action_view.javascript_expansions[:defaults] = %w(jquery rails) 42 | 43 | # Configure the default encoding used in templates for Ruby 1.9. 44 | config.encoding = 'utf-8' 45 | 46 | # Configure sensitive parameters which will be filtered from the log file. 47 | config.filter_parameters += [:password] 48 | end 49 | end 50 | -------------------------------------------------------------------------------- /spec/dummy/config/boot.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | require 'rubygems' 4 | 5 | # Set up gems listed in the Gemfile. 6 | gemfile = File.expand_path('../Gemfile', __dir__) 7 | if File.exist?(gemfile) 8 | begin 9 | ENV['BUNDLE_GEMFILE'] = gemfile 10 | require 'bundler' 11 | Bundler.setup 12 | rescue Bundler::GemNotFound => e 13 | warn e.message 14 | warn 'Try running `bundle install`.' 15 | exit! 16 | end 17 | end 18 | -------------------------------------------------------------------------------- /spec/dummy/config/configurable.yml: -------------------------------------------------------------------------------- 1 | notify_email: 2 | name: Notify Email 3 | type: string 4 | default: mreider@engineyard.com 5 | 6 | log_out_sso: 7 | name: Log user out of SSO on logout? 8 | type: boolean 9 | default: no 10 | 11 | accept_applications: 12 | name: Accepting Application 13 | type: boolean 14 | default: true 15 | 16 | conversion_rate: 17 | name: Conversion Rate 18 | type: decimal 19 | default: 1.0 20 | 21 | important_number: 22 | name: Important Number 23 | type: integer 24 | default: 1 25 | 26 | long_list: 27 | name: Long List 28 | type: list 29 | default: 30 | - [ One, 1 ] 31 | - [ Two, 2 ] 32 | - [ Three, 3 ] 33 | 34 | important_date: 35 | name: Important Date 36 | type: date 37 | default: '2015-05-14' 38 | -------------------------------------------------------------------------------- /spec/dummy/config/database.yml: -------------------------------------------------------------------------------- 1 | defaults: &defaults 2 | pool: 5 3 | timeout: 5000 4 | host: localhost 5 | adapter: sqlite3 6 | 7 | development: 8 | <<: *defaults 9 | database: db/development.sqlite3 10 | 11 | test: 12 | <<: *defaults 13 | database: db/test.sqlite3 14 | -------------------------------------------------------------------------------- /spec/dummy/config/environment.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | # Load the rails application 4 | require File.expand_path('application', __dir__) 5 | 6 | # Initialize the rails application 7 | Dummy::Application.initialize! 8 | -------------------------------------------------------------------------------- /spec/dummy/config/environments/development.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | Dummy::Application.configure do 4 | # Settings specified here will take precedence over those in config/application.rb 5 | 6 | # In the development environment your application's code is reloaded on 7 | # every request. This slows down response time but is perfect for development 8 | # since you don't have to restart the webserver when you make code changes. 9 | config.cache_classes = false 10 | 11 | # Show full error reports and disable caching 12 | config.consider_all_requests_local = true 13 | config.action_controller.perform_caching = false 14 | 15 | # Don't care if the mailer can't send 16 | config.action_mailer.raise_delivery_errors = false 17 | 18 | # Print deprecation notices to the Rails logger 19 | config.active_support.deprecation = :log 20 | 21 | # Only use best-standards-support built into browsers 22 | config.action_dispatch.best_standards_support = :builtin 23 | 24 | config.eager_load = false 25 | end 26 | -------------------------------------------------------------------------------- /spec/dummy/config/environments/production.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | Dummy::Application.configure do 4 | # Settings specified here will take precedence over those in config/application.rb 5 | 6 | # The production environment is meant for finished, "live" apps. 7 | # Code is not reloaded between requests 8 | config.cache_classes = true 9 | 10 | # Full error reports are disabled and caching is turned on 11 | config.consider_all_requests_local = false 12 | config.action_controller.perform_caching = true 13 | 14 | # Specifies the header that your server uses for sending files 15 | config.action_dispatch.x_sendfile_header = 'X-Sendfile' 16 | 17 | # For nginx: 18 | # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' 19 | 20 | # If you have no front-end server that supports something like X-Sendfile, 21 | # just comment this out and Rails will serve the files 22 | 23 | # See everything in the log (default is :info) 24 | # config.log_level = :debug 25 | 26 | # Use a different logger for distributed setups 27 | # config.logger = SyslogLogger.new 28 | 29 | # Use a different cache store in production 30 | # config.cache_store = :mem_cache_store 31 | 32 | # Disable Rails's static asset server 33 | # In production, Apache or nginx will already do this 34 | config.serve_static_assets = false 35 | 36 | # Enable serving of images, stylesheets, and javascripts from an asset server 37 | # config.action_controller.asset_host = "http://assets.example.com" 38 | 39 | # Disable delivery errors, bad email addresses will be ignored 40 | # config.action_mailer.raise_delivery_errors = false 41 | 42 | # Enable threaded mode 43 | # config.threadsafe! 44 | 45 | # Enable locale fallbacks for I18n (makes lookups for any locale fall back to 46 | # the I18n.default_locale when a translation can not be found) 47 | config.i18n.fallbacks = true 48 | 49 | # Send deprecation notices to registered listeners 50 | config.active_support.deprecation = :notify 51 | 52 | config.eager_load = true 53 | end 54 | -------------------------------------------------------------------------------- /spec/dummy/config/environments/test.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | if Rails.env.test? && !defined?(ActiveSupport::Cache::NullStore) 4 | module ActiveSupport 5 | module Cache 6 | # A cache store implementation which doesn't actually store anything. Useful in 7 | # development and test environments where you don't want caching turned on but 8 | # need to go through the caching interface. 9 | # 10 | # This cache does implement the local cache strategy, so values will actually 11 | # be cached inside blocks that utilize this strategy. See 12 | # ActiveSupport::Cache::Strategy::LocalCache for more details. 13 | class NullStore < Store 14 | def initialize(options = nil) 15 | super 16 | extend Strategy::LocalCache 17 | end 18 | 19 | def clear(options = nil); end 20 | 21 | def cleanup(options = nil); end 22 | 23 | def increment(name, amount = 1, options = nil); end 24 | 25 | def decrement(name, amount = 1, options = nil); end 26 | 27 | def delete_matched(matcher, options = nil); end 28 | 29 | protected 30 | 31 | def read_entry(key, options) # :nodoc: 32 | end 33 | 34 | def write_entry(_key, _entry, _options) # :nodoc: 35 | true 36 | end 37 | 38 | def delete_entry(_key, _options) # :nodoc: 39 | false 40 | end 41 | end 42 | end 43 | end 44 | end 45 | 46 | Dummy::Application.configure do 47 | # Settings specified here will take precedence over those in config/application.rb 48 | 49 | # The test environment is used exclusively to run your application's 50 | # test suite. You never need to work with it otherwise. Remember that 51 | # your test database is "scratch space" for the test suite and is wiped 52 | # and recreated between test runs. Don't rely on the data there! 53 | config.cache_classes = true 54 | 55 | # Show full error reports and disable caching 56 | config.consider_all_requests_local = true 57 | config.action_controller.perform_caching = false 58 | 59 | # Raise exceptions instead of rendering exception templates 60 | config.action_dispatch.show_exceptions = false 61 | 62 | # Disable request forgery protection in test environment 63 | config.action_controller.allow_forgery_protection = false 64 | 65 | # Disable caching during tests, 66 | # can't use :null_store syntax because of Rails 3.1 67 | config.cache_store = ActiveSupport::Cache::NullStore.new 68 | 69 | # Tell Action Mailer not to deliver emails to the real world. 70 | # The :test delivery method accumulates sent emails in the 71 | # ActionMailer::Base.deliveries array. 72 | config.action_mailer.delivery_method = :test 73 | 74 | # Use SQL instead of Active Record's schema dumper when creating the test database. 75 | # This is necessary if your schema can't be completely dumped by the schema dumper, 76 | # like if you have constraints or database-specific column types 77 | # config.active_record.schema_format = :sql 78 | 79 | # Print deprecation notices to the stderr 80 | config.active_support.deprecation = :stderr 81 | 82 | config.eager_load = false 83 | end 84 | -------------------------------------------------------------------------------- /spec/dummy/config/initializers/backtrace_silencers.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | # Be sure to restart your server when you modify this file. 4 | 5 | # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces. 6 | # Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ } 7 | 8 | # You can also remove all the silencers if you're trying to debug a problem that might stem from framework code. 9 | # Rails.backtrace_cleaner.remove_silencers! 10 | -------------------------------------------------------------------------------- /spec/dummy/config/initializers/inflections.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | # Be sure to restart your server when you modify this file. 4 | 5 | # Add new inflection rules using the following format 6 | # (all these examples are active by default): 7 | # ActiveSupport::Inflector.inflections do |inflect| 8 | # inflect.plural /^(ox)$/i, '\1en' 9 | # inflect.singular /^(ox)en/i, '\1' 10 | # inflect.irregular 'person', 'people' 11 | # inflect.uncountable %w( fish sheep ) 12 | # end 13 | -------------------------------------------------------------------------------- /spec/dummy/config/initializers/mime_types.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | # Be sure to restart your server when you modify this file. 4 | 5 | # Add new mime types for use in respond_to blocks: 6 | # Mime::Type.register "text/richtext", :rtf 7 | # Mime::Type.register_alias "text/html", :iphone 8 | -------------------------------------------------------------------------------- /spec/dummy/config/initializers/secret_token.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | # Be sure to restart your server when you modify this file. 4 | 5 | # Your secret key for verifying the integrity of signed cookies. 6 | # If you change this key, all old signed cookies will become invalid! 7 | # Make sure the secret is at least 30 characters and all random, 8 | # no regular words or you'll be exposed to dictionary attacks. 9 | Dummy::Application.config.secret_key_base = '9db18c716f4e6b1372516314e32714af7192f358978f8abbee21618db5c86d65f9ad1cf94d7d700eb37074de82c429b3334a1b5ef222c4660ea89ac9c3b9328a' 10 | -------------------------------------------------------------------------------- /spec/dummy/config/initializers/session_store.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | # Be sure to restart your server when you modify this file. 4 | 5 | Dummy::Application.config.session_store :cookie_store, key: '_dummy_session' 6 | 7 | # Use the database for sessions instead of the cookie-based default, 8 | # which shouldn't be used to store highly confidential information 9 | # (create the session table with "rails generate session_migration") 10 | # Dummy::Application.config.session_store :active_record_store 11 | -------------------------------------------------------------------------------- /spec/dummy/config/locales/en.yml: -------------------------------------------------------------------------------- 1 | # Sample localization file for English. Add more files in this directory for other locales. 2 | # See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points. 3 | 4 | en: 5 | hello: "Hello world" 6 | -------------------------------------------------------------------------------- /spec/dummy/config/routes.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | Dummy::Application.routes.draw do 4 | mount ConfigurableEngine::Engine, at: '/admin/configurable' 5 | end 6 | -------------------------------------------------------------------------------- /spec/dummy/db/migrate/20110110001344_create_configurables.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | class CreateConfigurables < ActiveRecord::Migration[5.2] 4 | def self.up 5 | create_table :configurables do |t| 6 | t.string :name 7 | t.string :value 8 | 9 | t.timestamps 10 | end 11 | 12 | add_index :configurables, :name 13 | end 14 | 15 | def self.down 16 | remove_index :configurables, :name 17 | drop_table :configurables 18 | end 19 | end 20 | -------------------------------------------------------------------------------- /spec/dummy/db/schema.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | # This file is auto-generated from the current state of the database. Instead 4 | # of editing this file, please use the migrations feature of Active Record to 5 | # incrementally modify your database, and then regenerate this schema definition. 6 | # 7 | # This file is the source Rails uses to define your schema when running `bin/rails 8 | # db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to 9 | # be faster and is potentially less error prone than running all of your 10 | # migrations from scratch. Old migrations may fail to apply correctly if those 11 | # migrations use external dependencies or application code. 12 | # 13 | # It's strongly recommended that you check this file into your version control system. 14 | 15 | ActiveRecord::Schema[7.2].define(version: 20_110_110_001_344) do 16 | create_table 'configurables', force: :cascade do |t| 17 | t.string 'name' 18 | t.string 'value' 19 | t.datetime 'created_at', precision: nil, null: false 20 | t.datetime 'updated_at', precision: nil, null: false 21 | t.index ['name'], name: 'index_configurables_on_name' 22 | end 23 | end 24 | -------------------------------------------------------------------------------- /spec/dummy/db/seeds.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | # This file should contain all the record creation needed to seed the database with its default values. 4 | # The data can then be loaded with the rake db:seed (or created alongside the db with db:setup). 5 | # 6 | # Examples: 7 | # 8 | # cities = City.create([{ :name => 'Chicago' }, { :name => 'Copenhagen' }]) 9 | # Mayor.create(:name => 'Daley', :city => cities.first) 10 | -------------------------------------------------------------------------------- /spec/dummy/lib/tasks/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/paulca/configurable_engine/5f7829bfbea5700f69d8c13bc795093d6db20fd9/spec/dummy/lib/tasks/.gitkeep -------------------------------------------------------------------------------- /spec/dummy/public/404.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | The page you were looking for doesn't exist (404) 5 | 17 | 18 | 19 | 20 | 21 |
22 |

The page you were looking for doesn't exist.

23 |

You may have mistyped the address or the page may have moved.

24 |
25 | 26 | 27 | -------------------------------------------------------------------------------- /spec/dummy/public/422.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | The change you wanted was rejected (422) 5 | 17 | 18 | 19 | 20 | 21 |
22 |

The change you wanted was rejected.

23 |

Maybe you tried to change something you didn't have access to.

24 |
25 | 26 | 27 | -------------------------------------------------------------------------------- /spec/dummy/public/500.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | We're sorry, but something went wrong (500) 5 | 17 | 18 | 19 | 20 | 21 |
22 |

We're sorry, but something went wrong.

23 |

We've been notified about this issue and we'll take a look at it shortly.

24 |
25 | 26 | 27 | -------------------------------------------------------------------------------- /spec/dummy/public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/paulca/configurable_engine/5f7829bfbea5700f69d8c13bc795093d6db20fd9/spec/dummy/public/favicon.ico -------------------------------------------------------------------------------- /spec/dummy/public/images/rails.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/paulca/configurable_engine/5f7829bfbea5700f69d8c13bc795093d6db20fd9/spec/dummy/public/images/rails.png -------------------------------------------------------------------------------- /spec/dummy/public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Ruby on Rails: Welcome aboard 5 | 172 | 185 | 186 | 187 |
188 | 201 | 202 |
203 | 207 | 208 | 212 | 213 |
214 |

Getting started

215 |

Here’s how to get rolling:

216 | 217 |
    218 |
  1. 219 |

    Use rails generate to create your models and controllers

    220 |

    To see all available options, run it without parameters.

    221 |
    2. 222 | 223 |
  2. 224 |

    Set up a default route and remove or rename this file

    225 |

    Routes are set up in config/routes.rb.

    226 |
    3. 227 | 228 |
  3. 229 |

    Create your database

    230 |

    Run rake db:migrate to create your database. If you're not using SQLite (the default), edit config/database.yml with your username and password.

    231 |
    4. 232 |
233 |
234 |
235 | 236 | 237 |
238 | 239 | 240 | -------------------------------------------------------------------------------- /spec/dummy/public/javascripts/application.js: -------------------------------------------------------------------------------- 1 | // Place your application-specific JavaScript functions and classes here 2 | // This file is automatically included by javascript_include_tag :defaults 3 | -------------------------------------------------------------------------------- /spec/dummy/public/javascripts/controls.js: -------------------------------------------------------------------------------- 1 | // script.aculo.us controls.js v1.8.3, Thu Oct 08 11:23:33 +0200 2009 2 | 3 | // Copyright (c) 2005-2009 Thomas Fuchs (http://script.aculo.us, http://mir.aculo.us) 4 | // (c) 2005-2009 Ivan Krstic (http://blogs.law.harvard.edu/ivan) 5 | // (c) 2005-2009 Jon Tirsen (http://www.tirsen.com) 6 | // Contributors: 7 | // Richard Livsey 8 | // Rahul Bhargava 9 | // Rob Wills 10 | // 11 | // script.aculo.us is freely distributable under the terms of an MIT-style license. 12 | // For details, see the script.aculo.us web site: http://script.aculo.us/ 13 | 14 | // Autocompleter.Base handles all the autocompletion functionality 15 | // that's independent of the data source for autocompletion. This 16 | // includes drawing the autocompletion menu, observing keyboard 17 | // and mouse events, and similar. 18 | // 19 | // Specific autocompleters need to provide, at the very least, 20 | // a getUpdatedChoices function that will be invoked every time 21 | // the text inside the monitored textbox changes. This method 22 | // should get the text for which to provide autocompletion by 23 | // invoking this.getToken(), NOT by directly accessing 24 | // this.element.value. This is to allow incremental tokenized 25 | // autocompletion. Specific auto-completion logic (AJAX, etc) 26 | // belongs in getUpdatedChoices. 27 | // 28 | // Tokenized incremental autocompletion is enabled automatically 29 | // when an autocompleter is instantiated with the 'tokens' option 30 | // in the options parameter, e.g.: 31 | // new Ajax.Autocompleter('id','upd', '/url/', { tokens: ',' }); 32 | // will incrementally autocomplete with a comma as the token. 33 | // Additionally, ',' in the above example can be replaced with 34 | // a token array, e.g. { tokens: [',', '\n'] } which 35 | // enables autocompletion on multiple tokens. This is most 36 | // useful when one of the tokens is \n (a newline), as it 37 | // allows smart autocompletion after linebreaks. 38 | 39 | if(typeof Effect == 'undefined') 40 | throw("controls.js requires including script.aculo.us' effects.js library"); 41 | 42 | var Autocompleter = { }; 43 | Autocompleter.Base = Class.create({ 44 | baseInitialize: function(element, update, options) { 45 | element = $(element); 46 | this.element = element; 47 | this.update = $(update); 48 | this.hasFocus = false; 49 | this.changed = false; 50 | this.active = false; 51 | this.index = 0; 52 | this.entryCount = 0; 53 | this.oldElementValue = this.element.value; 54 | 55 | if(this.setOptions) 56 | this.setOptions(options); 57 | else 58 | this.options = options || { }; 59 | 60 | this.options.paramName = this.options.paramName || this.element.name; 61 | this.options.tokens = this.options.tokens || []; 62 | this.options.frequency = this.options.frequency || 0.4; 63 | this.options.minChars = this.options.minChars || 1; 64 | this.options.onShow = this.options.onShow || 65 | function(element, update){ 66 | if(!update.style.position || update.style.position=='absolute') { 67 | update.style.position = 'absolute'; 68 | Position.clone(element, update, { 69 | setHeight: false, 70 | offsetTop: element.offsetHeight 71 | }); 72 | } 73 | Effect.Appear(update,{duration:0.15}); 74 | }; 75 | this.options.onHide = this.options.onHide || 76 | function(element, update){ new Effect.Fade(update,{duration:0.15}) }; 77 | 78 | if(typeof(this.options.tokens) == 'string') 79 | this.options.tokens = new Array(this.options.tokens); 80 | // Force carriage returns as token delimiters anyway 81 | if (!this.options.tokens.include('\n')) 82 | this.options.tokens.push('\n'); 83 | 84 | this.observer = null; 85 | 86 | this.element.setAttribute('autocomplete','off'); 87 | 88 | Element.hide(this.update); 89 | 90 | Event.observe(this.element, 'blur', this.onBlur.bindAsEventListener(this)); 91 | Event.observe(this.element, 'keydown', this.onKeyPress.bindAsEventListener(this)); 92 | }, 93 | 94 | show: function() { 95 | if(Element.getStyle(this.update, 'display')=='none') this.options.onShow(this.element, this.update); 96 | if(!this.iefix && 97 | (Prototype.Browser.IE) && 98 | (Element.getStyle(this.update, 'position')=='absolute')) { 99 | new Insertion.After(this.update, 100 | ''); 103 | this.iefix = $(this.update.id+'_iefix'); 104 | } 105 | if(this.iefix) setTimeout(this.fixIEOverlapping.bind(this), 50); 106 | }, 107 | 108 | fixIEOverlapping: function() { 109 | Position.clone(this.update, this.iefix, {setTop:(!this.update.style.height)}); 110 | this.iefix.style.zIndex = 1; 111 | this.update.style.zIndex = 2; 112 | Element.show(this.iefix); 113 | }, 114 | 115 | hide: function() { 116 | this.stopIndicator(); 117 | if(Element.getStyle(this.update, 'display')!='none') this.options.onHide(this.element, this.update); 118 | if(this.iefix) Element.hide(this.iefix); 119 | }, 120 | 121 | startIndicator: function() { 122 | if(this.options.indicator) Element.show(this.options.indicator); 123 | }, 124 | 125 | stopIndicator: function() { 126 | if(this.options.indicator) Element.hide(this.options.indicator); 127 | }, 128 | 129 | onKeyPress: function(event) { 130 | if(this.active) 131 | switch(event.keyCode) { 132 | case Event.KEY_TAB: 133 | case Event.KEY_RETURN: 134 | this.selectEntry(); 135 | Event.stop(event); 136 | case Event.KEY_ESC: 137 | this.hide(); 138 | this.active = false; 139 | Event.stop(event); 140 | return; 141 | case Event.KEY_LEFT: 142 | case Event.KEY_RIGHT: 143 | return; 144 | case Event.KEY_UP: 145 | this.markPrevious(); 146 | this.render(); 147 | Event.stop(event); 148 | return; 149 | case Event.KEY_DOWN: 150 | this.markNext(); 151 | this.render(); 152 | Event.stop(event); 153 | return; 154 | } 155 | else 156 | if(event.keyCode==Event.KEY_TAB || event.keyCode==Event.KEY_RETURN || 157 | (Prototype.Browser.WebKit > 0 && event.keyCode == 0)) return; 158 | 159 | this.changed = true; 160 | this.hasFocus = true; 161 | 162 | if(this.observer) clearTimeout(this.observer); 163 | this.observer = 164 | setTimeout(this.onObserverEvent.bind(this), this.options.frequency*1000); 165 | }, 166 | 167 | activate: function() { 168 | this.changed = false; 169 | this.hasFocus = true; 170 | this.getUpdatedChoices(); 171 | }, 172 | 173 | onHover: function(event) { 174 | var element = Event.findElement(event, 'LI'); 175 | if(this.index != element.autocompleteIndex) 176 | { 177 | this.index = element.autocompleteIndex; 178 | this.render(); 179 | } 180 | Event.stop(event); 181 | }, 182 | 183 | onClick: function(event) { 184 | var element = Event.findElement(event, 'LI'); 185 | this.index = element.autocompleteIndex; 186 | this.selectEntry(); 187 | this.hide(); 188 | }, 189 | 190 | onBlur: function(event) { 191 | // needed to make click events working 192 | setTimeout(this.hide.bind(this), 250); 193 | this.hasFocus = false; 194 | this.active = false; 195 | }, 196 | 197 | render: function() { 198 | if(this.entryCount > 0) { 199 | for (var i = 0; i < this.entryCount; i++) 200 | this.index==i ? 201 | Element.addClassName(this.getEntry(i),"selected") : 202 | Element.removeClassName(this.getEntry(i),"selected"); 203 | if(this.hasFocus) { 204 | this.show(); 205 | this.active = true; 206 | } 207 | } else { 208 | this.active = false; 209 | this.hide(); 210 | } 211 | }, 212 | 213 | markPrevious: function() { 214 | if(this.index > 0) this.index--; 215 | else this.index = this.entryCount-1; 216 | this.getEntry(this.index).scrollIntoView(true); 217 | }, 218 | 219 | markNext: function() { 220 | if(this.index < this.entryCount-1) this.index++; 221 | else this.index = 0; 222 | this.getEntry(this.index).scrollIntoView(false); 223 | }, 224 | 225 | getEntry: function(index) { 226 | return this.update.firstChild.childNodes[index]; 227 | }, 228 | 229 | getCurrentEntry: function() { 230 | return this.getEntry(this.index); 231 | }, 232 | 233 | selectEntry: function() { 234 | this.active = false; 235 | this.updateElement(this.getCurrentEntry()); 236 | }, 237 | 238 | updateElement: function(selectedElement) { 239 | if (this.options.updateElement) { 240 | this.options.updateElement(selectedElement); 241 | return; 242 | } 243 | var value = ''; 244 | if (this.options.select) { 245 | var nodes = $(selectedElement).select('.' + this.options.select) || []; 246 | if(nodes.length>0) value = Element.collectTextNodes(nodes[0], this.options.select); 247 | } else 248 | value = Element.collectTextNodesIgnoreClass(selectedElement, 'informal'); 249 | 250 | var bounds = this.getTokenBounds(); 251 | if (bounds[0] != -1) { 252 | var newValue = this.element.value.substr(0, bounds[0]); 253 | var whitespace = this.element.value.substr(bounds[0]).match(/^\s+/); 254 | if (whitespace) 255 | newValue += whitespace[0]; 256 | this.element.value = newValue + value + this.element.value.substr(bounds[1]); 257 | } else { 258 | this.element.value = value; 259 | } 260 | this.oldElementValue = this.element.value; 261 | this.element.focus(); 262 | 263 | if (this.options.afterUpdateElement) 264 | this.options.afterUpdateElement(this.element, selectedElement); 265 | }, 266 | 267 | updateChoices: function(choices) { 268 | if(!this.changed && this.hasFocus) { 269 | this.update.innerHTML = choices; 270 | Element.cleanWhitespace(this.update); 271 | Element.cleanWhitespace(this.update.down()); 272 | 273 | if(this.update.firstChild && this.update.down().childNodes) { 274 | this.entryCount = 275 | this.update.down().childNodes.length; 276 | for (var i = 0; i < this.entryCount; i++) { 277 | var entry = this.getEntry(i); 278 | entry.autocompleteIndex = i; 279 | this.addObservers(entry); 280 | } 281 | } else { 282 | this.entryCount = 0; 283 | } 284 | 285 | this.stopIndicator(); 286 | this.index = 0; 287 | 288 | if(this.entryCount==1 && this.options.autoSelect) { 289 | this.selectEntry(); 290 | this.hide(); 291 | } else { 292 | this.render(); 293 | } 294 | } 295 | }, 296 | 297 | addObservers: function(element) { 298 | Event.observe(element, "mouseover", this.onHover.bindAsEventListener(this)); 299 | Event.observe(element, "click", this.onClick.bindAsEventListener(this)); 300 | }, 301 | 302 | onObserverEvent: function() { 303 | this.changed = false; 304 | this.tokenBounds = null; 305 | if(this.getToken().length>=this.options.minChars) { 306 | this.getUpdatedChoices(); 307 | } else { 308 | this.active = false; 309 | this.hide(); 310 | } 311 | this.oldElementValue = this.element.value; 312 | }, 313 | 314 | getToken: function() { 315 | var bounds = this.getTokenBounds(); 316 | return this.element.value.substring(bounds[0], bounds[1]).strip(); 317 | }, 318 | 319 | getTokenBounds: function() { 320 | if (null != this.tokenBounds) return this.tokenBounds; 321 | var value = this.element.value; 322 | if (value.strip().empty()) return [-1, 0]; 323 | var diff = arguments.callee.getFirstDifferencePos(value, this.oldElementValue); 324 | var offset = (diff == this.oldElementValue.length ? 1 : 0); 325 | var prevTokenPos = -1, nextTokenPos = value.length; 326 | var tp; 327 | for (var index = 0, l = this.options.tokens.length; index < l; ++index) { 328 | tp = value.lastIndexOf(this.options.tokens[index], diff + offset - 1); 329 | if (tp > prevTokenPos) prevTokenPos = tp; 330 | tp = value.indexOf(this.options.tokens[index], diff + offset); 331 | if (-1 != tp && tp < nextTokenPos) nextTokenPos = tp; 332 | } 333 | return (this.tokenBounds = [prevTokenPos + 1, nextTokenPos]); 334 | } 335 | }); 336 | 337 | Autocompleter.Base.prototype.getTokenBounds.getFirstDifferencePos = function(newS, oldS) { 338 | var boundary = Math.min(newS.length, oldS.length); 339 | for (var index = 0; index < boundary; ++index) 340 | if (newS[index] != oldS[index]) 341 | return index; 342 | return boundary; 343 | }; 344 | 345 | Ajax.Autocompleter = Class.create(Autocompleter.Base, { 346 | initialize: function(element, update, url, options) { 347 | this.baseInitialize(element, update, options); 348 | this.options.asynchronous = true; 349 | this.options.onComplete = this.onComplete.bind(this); 350 | this.options.defaultParams = this.options.parameters || null; 351 | this.url = url; 352 | }, 353 | 354 | getUpdatedChoices: function() { 355 | this.startIndicator(); 356 | 357 | var entry = encodeURIComponent(this.options.paramName) + '=' + 358 | encodeURIComponent(this.getToken()); 359 | 360 | this.options.parameters = this.options.callback ? 361 | this.options.callback(this.element, entry) : entry; 362 | 363 | if(this.options.defaultParams) 364 | this.options.parameters += '&' + this.options.defaultParams; 365 | 366 | new Ajax.Request(this.url, this.options); 367 | }, 368 | 369 | onComplete: function(request) { 370 | this.updateChoices(request.responseText); 371 | } 372 | }); 373 | 374 | // The local array autocompleter. Used when you'd prefer to 375 | // inject an array of autocompletion options into the page, rather 376 | // than sending out Ajax queries, which can be quite slow sometimes. 377 | // 378 | // The constructor takes four parameters. The first two are, as usual, 379 | // the id of the monitored textbox, and id of the autocompletion menu. 380 | // The third is the array you want to autocomplete from, and the fourth 381 | // is the options block. 382 | // 383 | // Extra local autocompletion options: 384 | // - choices - How many autocompletion choices to offer 385 | // 386 | // - partialSearch - If false, the autocompleter will match entered 387 | // text only at the beginning of strings in the 388 | // autocomplete array. Defaults to true, which will 389 | // match text at the beginning of any *word* in the 390 | // strings in the autocomplete array. If you want to 391 | // search anywhere in the string, additionally set 392 | // the option fullSearch to true (default: off). 393 | // 394 | // - fullSsearch - Search anywhere in autocomplete array strings. 395 | // 396 | // - partialChars - How many characters to enter before triggering 397 | // a partial match (unlike minChars, which defines 398 | // how many characters are required to do any match 399 | // at all). Defaults to 2. 400 | // 401 | // - ignoreCase - Whether to ignore case when autocompleting. 402 | // Defaults to true. 403 | // 404 | // It's possible to pass in a custom function as the 'selector' 405 | // option, if you prefer to write your own autocompletion logic. 406 | // In that case, the other options above will not apply unless 407 | // you support them. 408 | 409 | Autocompleter.Local = Class.create(Autocompleter.Base, { 410 | initialize: function(element, update, array, options) { 411 | this.baseInitialize(element, update, options); 412 | this.options.array = array; 413 | }, 414 | 415 | getUpdatedChoices: function() { 416 | this.updateChoices(this.options.selector(this)); 417 | }, 418 | 419 | setOptions: function(options) { 420 | this.options = Object.extend({ 421 | choices: 10, 422 | partialSearch: true, 423 | partialChars: 2, 424 | ignoreCase: true, 425 | fullSearch: false, 426 | selector: function(instance) { 427 | var ret = []; // Beginning matches 428 | var partial = []; // Inside matches 429 | var entry = instance.getToken(); 430 | var count = 0; 431 | 432 | for (var i = 0; i < instance.options.array.length && 433 | ret.length < instance.options.choices ; i++) { 434 | 435 | var elem = instance.options.array[i]; 436 | var foundPos = instance.options.ignoreCase ? 437 | elem.toLowerCase().indexOf(entry.toLowerCase()) : 438 | elem.indexOf(entry); 439 | 440 | while (foundPos != -1) { 441 | if (foundPos == 0 && elem.length != entry.length) { 442 | ret.push("
  • " + elem.substr(0, entry.length) + "" + 443 | elem.substr(entry.length) + "
    • "); 444 | break; 445 | } else if (entry.length >= instance.options.partialChars && 446 | instance.options.partialSearch && foundPos != -1) { 447 | if (instance.options.fullSearch || /\s/.test(elem.substr(foundPos-1,1))) { 448 | partial.push("
  • " + elem.substr(0, foundPos) + "" + 449 | elem.substr(foundPos, entry.length) + "" + elem.substr( 450 | foundPos + entry.length) + "
    • "); 451 | break; 452 | } 453 | } 454 | 455 | foundPos = instance.options.ignoreCase ? 456 | elem.toLowerCase().indexOf(entry.toLowerCase(), foundPos + 1) : 457 | elem.indexOf(entry, foundPos + 1); 458 | 459 | } 460 | } 461 | if (partial.length) 462 | ret = ret.concat(partial.slice(0, instance.options.choices - ret.length)); 463 | return ""; 464 | } 465 | }, options || { }); 466 | } 467 | }); 468 | 469 | // AJAX in-place editor and collection editor 470 | // Full rewrite by Christophe Porteneuve (April 2007). 471 | 472 | // Use this if you notice weird scrolling problems on some browsers, 473 | // the DOM might be a bit confused when this gets called so do this 474 | // waits 1 ms (with setTimeout) until it does the activation 475 | Field.scrollFreeActivate = function(field) { 476 | setTimeout(function() { 477 | Field.activate(field); 478 | }, 1); 479 | }; 480 | 481 | Ajax.InPlaceEditor = Class.create({ 482 | initialize: function(element, url, options) { 483 | this.url = url; 484 | this.element = element = $(element); 485 | this.prepareOptions(); 486 | this._controls = { }; 487 | arguments.callee.dealWithDeprecatedOptions(options); // DEPRECATION LAYER!!! 488 | Object.extend(this.options, options || { }); 489 | if (!this.options.formId && this.element.id) { 490 | this.options.formId = this.element.id + '-inplaceeditor'; 491 | if ($(this.options.formId)) 492 | this.options.formId = ''; 493 | } 494 | if (this.options.externalControl) 495 | this.options.externalControl = $(this.options.externalControl); 496 | if (!this.options.externalControl) 497 | this.options.externalControlOnly = false; 498 | this._originalBackground = this.element.getStyle('background-color') || 'transparent'; 499 | this.element.title = this.options.clickToEditText; 500 | this._boundCancelHandler = this.handleFormCancellation.bind(this); 501 | this._boundComplete = (this.options.onComplete || Prototype.emptyFunction).bind(this); 502 | this._boundFailureHandler = this.handleAJAXFailure.bind(this); 503 | this._boundSubmitHandler = this.handleFormSubmission.bind(this); 504 | this._boundWrapperHandler = this.wrapUp.bind(this); 505 | this.registerListeners(); 506 | }, 507 | checkForEscapeOrReturn: function(e) { 508 | if (!this._editing || e.ctrlKey || e.altKey || e.shiftKey) return; 509 | if (Event.KEY_ESC == e.keyCode) 510 | this.handleFormCancellation(e); 511 | else if (Event.KEY_RETURN == e.keyCode) 512 | this.handleFormSubmission(e); 513 | }, 514 | createControl: function(mode, handler, extraClasses) { 515 | var control = this.options[mode + 'Control']; 516 | var text = this.options[mode + 'Text']; 517 | if ('button' == control) { 518 | var btn = document.createElement('input'); 519 | btn.type = 'submit'; 520 | btn.value = text; 521 | btn.className = 'editor_' + mode + '_button'; 522 | if ('cancel' == mode) 523 | btn.onclick = this._boundCancelHandler; 524 | this._form.appendChild(btn); 525 | this._controls[mode] = btn; 526 | } else if ('link' == control) { 527 | var link = document.createElement('a'); 528 | link.href = '#'; 529 | link.appendChild(document.createTextNode(text)); 530 | link.onclick = 'cancel' == mode ? this._boundCancelHandler : this._boundSubmitHandler; 531 | link.className = 'editor_' + mode + '_link'; 532 | if (extraClasses) 533 | link.className += ' ' + extraClasses; 534 | this._form.appendChild(link); 535 | this._controls[mode] = link; 536 | } 537 | }, 538 | createEditField: function() { 539 | var text = (this.options.loadTextURL ? this.options.loadingText : this.getText()); 540 | var fld; 541 | if (1 >= this.options.rows && !/\r|\n/.test(this.getText())) { 542 | fld = document.createElement('input'); 543 | fld.type = 'text'; 544 | var size = this.options.size || this.options.cols || 0; 545 | if (0 < size) fld.size = size; 546 | } else { 547 | fld = document.createElement('textarea'); 548 | fld.rows = (1 >= this.options.rows ? this.options.autoRows : this.options.rows); 549 | fld.cols = this.options.cols || 40; 550 | } 551 | fld.name = this.options.paramName; 552 | fld.value = text; // No HTML breaks conversion anymore 553 | fld.className = 'editor_field'; 554 | if (this.options.submitOnBlur) 555 | fld.onblur = this._boundSubmitHandler; 556 | this._controls.editor = fld; 557 | if (this.options.loadTextURL) 558 | this.loadExternalText(); 559 | this._form.appendChild(this._controls.editor); 560 | }, 561 | createForm: function() { 562 | var ipe = this; 563 | function addText(mode, condition) { 564 | var text = ipe.options['text' + mode + 'Controls']; 565 | if (!text || condition === false) return; 566 | ipe._form.appendChild(document.createTextNode(text)); 567 | }; 568 | this._form = $(document.createElement('form')); 569 | this._form.id = this.options.formId; 570 | this._form.addClassName(this.options.formClassName); 571 | this._form.onsubmit = this._boundSubmitHandler; 572 | this.createEditField(); 573 | if ('textarea' == this._controls.editor.tagName.toLowerCase()) 574 | this._form.appendChild(document.createElement('br')); 575 | if (this.options.onFormCustomization) 576 | this.options.onFormCustomization(this, this._form); 577 | addText('Before', this.options.okControl || this.options.cancelControl); 578 | this.createControl('ok', this._boundSubmitHandler); 579 | addText('Between', this.options.okControl && this.options.cancelControl); 580 | this.createControl('cancel', this._boundCancelHandler, 'editor_cancel'); 581 | addText('After', this.options.okControl || this.options.cancelControl); 582 | }, 583 | destroy: function() { 584 | if (this._oldInnerHTML) 585 | this.element.innerHTML = this._oldInnerHTML; 586 | this.leaveEditMode(); 587 | this.unregisterListeners(); 588 | }, 589 | enterEditMode: function(e) { 590 | if (this._saving || this._editing) return; 591 | this._editing = true; 592 | this.triggerCallback('onEnterEditMode'); 593 | if (this.options.externalControl) 594 | this.options.externalControl.hide(); 595 | this.element.hide(); 596 | this.createForm(); 597 | this.element.parentNode.insertBefore(this._form, this.element); 598 | if (!this.options.loadTextURL) 599 | this.postProcessEditField(); 600 | if (e) Event.stop(e); 601 | }, 602 | enterHover: function(e) { 603 | if (this.options.hoverClassName) 604 | this.element.addClassName(this.options.hoverClassName); 605 | if (this._saving) return; 606 | this.triggerCallback('onEnterHover'); 607 | }, 608 | getText: function() { 609 | return this.element.innerHTML.unescapeHTML(); 610 | }, 611 | handleAJAXFailure: function(transport) { 612 | this.triggerCallback('onFailure', transport); 613 | if (this._oldInnerHTML) { 614 | this.element.innerHTML = this._oldInnerHTML; 615 | this._oldInnerHTML = null; 616 | } 617 | }, 618 | handleFormCancellation: function(e) { 619 | this.wrapUp(); 620 | if (e) Event.stop(e); 621 | }, 622 | handleFormSubmission: function(e) { 623 | var form = this._form; 624 | var value = $F(this._controls.editor); 625 | this.prepareSubmission(); 626 | var params = this.options.callback(form, value) || ''; 627 | if (Object.isString(params)) 628 | params = params.toQueryParams(); 629 | params.editorId = this.element.id; 630 | if (this.options.htmlResponse) { 631 | var options = Object.extend({ evalScripts: true }, this.options.ajaxOptions); 632 | Object.extend(options, { 633 | parameters: params, 634 | onComplete: this._boundWrapperHandler, 635 | onFailure: this._boundFailureHandler 636 | }); 637 | new Ajax.Updater({ success: this.element }, this.url, options); 638 | } else { 639 | var options = Object.extend({ method: 'get' }, this.options.ajaxOptions); 640 | Object.extend(options, { 641 | parameters: params, 642 | onComplete: this._boundWrapperHandler, 643 | onFailure: this._boundFailureHandler 644 | }); 645 | new Ajax.Request(this.url, options); 646 | } 647 | if (e) Event.stop(e); 648 | }, 649 | leaveEditMode: function() { 650 | this.element.removeClassName(this.options.savingClassName); 651 | this.removeForm(); 652 | this.leaveHover(); 653 | this.element.style.backgroundColor = this._originalBackground; 654 | this.element.show(); 655 | if (this.options.externalControl) 656 | this.options.externalControl.show(); 657 | this._saving = false; 658 | this._editing = false; 659 | this._oldInnerHTML = null; 660 | this.triggerCallback('onLeaveEditMode'); 661 | }, 662 | leaveHover: function(e) { 663 | if (this.options.hoverClassName) 664 | this.element.removeClassName(this.options.hoverClassName); 665 | if (this._saving) return; 666 | this.triggerCallback('onLeaveHover'); 667 | }, 668 | loadExternalText: function() { 669 | this._form.addClassName(this.options.loadingClassName); 670 | this._controls.editor.disabled = true; 671 | var options = Object.extend({ method: 'get' }, this.options.ajaxOptions); 672 | Object.extend(options, { 673 | parameters: 'editorId=' + encodeURIComponent(this.element.id), 674 | onComplete: Prototype.emptyFunction, 675 | onSuccess: function(transport) { 676 | this._form.removeClassName(this.options.loadingClassName); 677 | var text = transport.responseText; 678 | if (this.options.stripLoadedTextTags) 679 | text = text.stripTags(); 680 | this._controls.editor.value = text; 681 | this._controls.editor.disabled = false; 682 | this.postProcessEditField(); 683 | }.bind(this), 684 | onFailure: this._boundFailureHandler 685 | }); 686 | new Ajax.Request(this.options.loadTextURL, options); 687 | }, 688 | postProcessEditField: function() { 689 | var fpc = this.options.fieldPostCreation; 690 | if (fpc) 691 | $(this._controls.editor)['focus' == fpc ? 'focus' : 'activate'](); 692 | }, 693 | prepareOptions: function() { 694 | this.options = Object.clone(Ajax.InPlaceEditor.DefaultOptions); 695 | Object.extend(this.options, Ajax.InPlaceEditor.DefaultCallbacks); 696 | [this._extraDefaultOptions].flatten().compact().each(function(defs) { 697 | Object.extend(this.options, defs); 698 | }.bind(this)); 699 | }, 700 | prepareSubmission: function() { 701 | this._saving = true; 702 | this.removeForm(); 703 | this.leaveHover(); 704 | this.showSaving(); 705 | }, 706 | registerListeners: function() { 707 | this._listeners = { }; 708 | var listener; 709 | $H(Ajax.InPlaceEditor.Listeners).each(function(pair) { 710 | listener = this[pair.value].bind(this); 711 | this._listeners[pair.key] = listener; 712 | if (!this.options.externalControlOnly) 713 | this.element.observe(pair.key, listener); 714 | if (this.options.externalControl) 715 | this.options.externalControl.observe(pair.key, listener); 716 | }.bind(this)); 717 | }, 718 | removeForm: function() { 719 | if (!this._form) return; 720 | this._form.remove(); 721 | this._form = null; 722 | this._controls = { }; 723 | }, 724 | showSaving: function() { 725 | this._oldInnerHTML = this.element.innerHTML; 726 | this.element.innerHTML = this.options.savingText; 727 | this.element.addClassName(this.options.savingClassName); 728 | this.element.style.backgroundColor = this._originalBackground; 729 | this.element.show(); 730 | }, 731 | triggerCallback: function(cbName, arg) { 732 | if ('function' == typeof this.options[cbName]) { 733 | this.options[cbName](this, arg); 734 | } 735 | }, 736 | unregisterListeners: function() { 737 | $H(this._listeners).each(function(pair) { 738 | if (!this.options.externalControlOnly) 739 | this.element.stopObserving(pair.key, pair.value); 740 | if (this.options.externalControl) 741 | this.options.externalControl.stopObserving(pair.key, pair.value); 742 | }.bind(this)); 743 | }, 744 | wrapUp: function(transport) { 745 | this.leaveEditMode(); 746 | // Can't use triggerCallback due to backward compatibility: requires 747 | // binding + direct element 748 | this._boundComplete(transport, this.element); 749 | } 750 | }); 751 | 752 | Object.extend(Ajax.InPlaceEditor.prototype, { 753 | dispose: Ajax.InPlaceEditor.prototype.destroy 754 | }); 755 | 756 | Ajax.InPlaceCollectionEditor = Class.create(Ajax.InPlaceEditor, { 757 | initialize: function($super, element, url, options) { 758 | this._extraDefaultOptions = Ajax.InPlaceCollectionEditor.DefaultOptions; 759 | $super(element, url, options); 760 | }, 761 | 762 | createEditField: function() { 763 | var list = document.createElement('select'); 764 | list.name = this.options.paramName; 765 | list.size = 1; 766 | this._controls.editor = list; 767 | this._collection = this.options.collection || []; 768 | if (this.options.loadCollectionURL) 769 | this.loadCollection(); 770 | else 771 | this.checkForExternalText(); 772 | this._form.appendChild(this._controls.editor); 773 | }, 774 | 775 | loadCollection: function() { 776 | this._form.addClassName(this.options.loadingClassName); 777 | this.showLoadingText(this.options.loadingCollectionText); 778 | var options = Object.extend({ method: 'get' }, this.options.ajaxOptions); 779 | Object.extend(options, { 780 | parameters: 'editorId=' + encodeURIComponent(this.element.id), 781 | onComplete: Prototype.emptyFunction, 782 | onSuccess: function(transport) { 783 | var js = transport.responseText.strip(); 784 | if (!/^\[.*\]$/.test(js)) // TODO: improve sanity check 785 | throw('Server returned an invalid collection representation.'); 786 | this._collection = eval(js); 787 | this.checkForExternalText(); 788 | }.bind(this), 789 | onFailure: this.onFailure 790 | }); 791 | new Ajax.Request(this.options.loadCollectionURL, options); 792 | }, 793 | 794 | showLoadingText: function(text) { 795 | this._controls.editor.disabled = true; 796 | var tempOption = this._controls.editor.firstChild; 797 | if (!tempOption) { 798 | tempOption = document.createElement('option'); 799 | tempOption.value = ''; 800 | this._controls.editor.appendChild(tempOption); 801 | tempOption.selected = true; 802 | } 803 | tempOption.update((text || '').stripScripts().stripTags()); 804 | }, 805 | 806 | checkForExternalText: function() { 807 | this._text = this.getText(); 808 | if (this.options.loadTextURL) 809 | this.loadExternalText(); 810 | else 811 | this.buildOptionList(); 812 | }, 813 | 814 | loadExternalText: function() { 815 | this.showLoadingText(this.options.loadingText); 816 | var options = Object.extend({ method: 'get' }, this.options.ajaxOptions); 817 | Object.extend(options, { 818 | parameters: 'editorId=' + encodeURIComponent(this.element.id), 819 | onComplete: Prototype.emptyFunction, 820 | onSuccess: function(transport) { 821 | this._text = transport.responseText.strip(); 822 | this.buildOptionList(); 823 | }.bind(this), 824 | onFailure: this.onFailure 825 | }); 826 | new Ajax.Request(this.options.loadTextURL, options); 827 | }, 828 | 829 | buildOptionList: function() { 830 | this._form.removeClassName(this.options.loadingClassName); 831 | this._collection = this._collection.map(function(entry) { 832 | return 2 === entry.length ? entry : [entry, entry].flatten(); 833 | }); 834 | var marker = ('value' in this.options) ? this.options.value : this._text; 835 | var textFound = this._collection.any(function(entry) { 836 | return entry[0] == marker; 837 | }.bind(this)); 838 | this._controls.editor.update(''); 839 | var option; 840 | this._collection.each(function(entry, index) { 841 | option = document.createElement('option'); 842 | option.value = entry[0]; 843 | option.selected = textFound ? entry[0] == marker : 0 == index; 844 | option.appendChild(document.createTextNode(entry[1])); 845 | this._controls.editor.appendChild(option); 846 | }.bind(this)); 847 | this._controls.editor.disabled = false; 848 | Field.scrollFreeActivate(this._controls.editor); 849 | } 850 | }); 851 | 852 | //**** DEPRECATION LAYER FOR InPlace[Collection]Editor! **** 853 | //**** This only exists for a while, in order to let **** 854 | //**** users adapt to the new API. Read up on the new **** 855 | //**** API and convert your code to it ASAP! **** 856 | 857 | Ajax.InPlaceEditor.prototype.initialize.dealWithDeprecatedOptions = function(options) { 858 | if (!options) return; 859 | function fallback(name, expr) { 860 | if (name in options || expr === undefined) return; 861 | options[name] = expr; 862 | }; 863 | fallback('cancelControl', (options.cancelLink ? 'link' : (options.cancelButton ? 'button' : 864 | options.cancelLink == options.cancelButton == false ? false : undefined))); 865 | fallback('okControl', (options.okLink ? 'link' : (options.okButton ? 'button' : 866 | options.okLink == options.okButton == false ? false : undefined))); 867 | fallback('highlightColor', options.highlightcolor); 868 | fallback('highlightEndColor', options.highlightendcolor); 869 | }; 870 | 871 | Object.extend(Ajax.InPlaceEditor, { 872 | DefaultOptions: { 873 | ajaxOptions: { }, 874 | autoRows: 3, // Use when multi-line w/ rows == 1 875 | cancelControl: 'link', // 'link'|'button'|false 876 | cancelText: 'cancel', 877 | clickToEditText: 'Click to edit', 878 | externalControl: null, // id|elt 879 | externalControlOnly: false, 880 | fieldPostCreation: 'activate', // 'activate'|'focus'|false 881 | formClassName: 'inplaceeditor-form', 882 | formId: null, // id|elt 883 | highlightColor: '#ffff99', 884 | highlightEndColor: '#ffffff', 885 | hoverClassName: '', 886 | htmlResponse: true, 887 | loadingClassName: 'inplaceeditor-loading', 888 | loadingText: 'Loading...', 889 | okControl: 'button', // 'link'|'button'|false 890 | okText: 'ok', 891 | paramName: 'value', 892 | rows: 1, // If 1 and multi-line, uses autoRows 893 | savingClassName: 'inplaceeditor-saving', 894 | savingText: 'Saving...', 895 | size: 0, 896 | stripLoadedTextTags: false, 897 | submitOnBlur: false, 898 | textAfterControls: '', 899 | textBeforeControls: '', 900 | textBetweenControls: '' 901 | }, 902 | DefaultCallbacks: { 903 | callback: function(form) { 904 | return Form.serialize(form); 905 | }, 906 | onComplete: function(transport, element) { 907 | // For backward compatibility, this one is bound to the IPE, and passes 908 | // the element directly. It was too often customized, so we don't break it. 909 | new Effect.Highlight(element, { 910 | startcolor: this.options.highlightColor, keepBackgroundImage: true }); 911 | }, 912 | onEnterEditMode: null, 913 | onEnterHover: function(ipe) { 914 | ipe.element.style.backgroundColor = ipe.options.highlightColor; 915 | if (ipe._effect) 916 | ipe._effect.cancel(); 917 | }, 918 | onFailure: function(transport, ipe) { 919 | alert('Error communication with the server: ' + transport.responseText.stripTags()); 920 | }, 921 | onFormCustomization: null, // Takes the IPE and its generated form, after editor, before controls. 922 | onLeaveEditMode: null, 923 | onLeaveHover: function(ipe) { 924 | ipe._effect = new Effect.Highlight(ipe.element, { 925 | startcolor: ipe.options.highlightColor, endcolor: ipe.options.highlightEndColor, 926 | restorecolor: ipe._originalBackground, keepBackgroundImage: true 927 | }); 928 | } 929 | }, 930 | Listeners: { 931 | click: 'enterEditMode', 932 | keydown: 'checkForEscapeOrReturn', 933 | mouseover: 'enterHover', 934 | mouseout: 'leaveHover' 935 | } 936 | }); 937 | 938 | Ajax.InPlaceCollectionEditor.DefaultOptions = { 939 | loadingCollectionText: 'Loading options...' 940 | }; 941 | 942 | // Delayed observer, like Form.Element.Observer, 943 | // but waits for delay after last key input 944 | // Ideal for live-search fields 945 | 946 | Form.Element.DelayedObserver = Class.create({ 947 | initialize: function(element, delay, callback) { 948 | this.delay = delay || 0.5; 949 | this.element = $(element); 950 | this.callback = callback; 951 | this.timer = null; 952 | this.lastValue = $F(this.element); 953 | Event.observe(this.element,'keyup',this.delayedListener.bindAsEventListener(this)); 954 | }, 955 | delayedListener: function(event) { 956 | if(this.lastValue == $F(this.element)) return; 957 | if(this.timer) clearTimeout(this.timer); 958 | this.timer = setTimeout(this.onTimerEvent.bind(this), this.delay * 1000); 959 | this.lastValue = $F(this.element); 960 | }, 961 | onTimerEvent: function() { 962 | this.timer = null; 963 | this.callback(this.element, $F(this.element)); 964 | } 965 | }); -------------------------------------------------------------------------------- /spec/dummy/public/javascripts/dragdrop.js: -------------------------------------------------------------------------------- 1 | // script.aculo.us dragdrop.js v1.8.3, Thu Oct 08 11:23:33 +0200 2009 2 | 3 | // Copyright (c) 2005-2009 Thomas Fuchs (http://script.aculo.us, http://mir.aculo.us) 4 | // 5 | // script.aculo.us is freely distributable under the terms of an MIT-style license. 6 | // For details, see the script.aculo.us web site: http://script.aculo.us/ 7 | 8 | if(Object.isUndefined(Effect)) 9 | throw("dragdrop.js requires including script.aculo.us' effects.js library"); 10 | 11 | var Droppables = { 12 | drops: [], 13 | 14 | remove: function(element) { 15 | this.drops = this.drops.reject(function(d) { return d.element==$(element) }); 16 | }, 17 | 18 | add: function(element) { 19 | element = $(element); 20 | var options = Object.extend({ 21 | greedy: true, 22 | hoverclass: null, 23 | tree: false 24 | }, arguments[1] || { }); 25 | 26 | // cache containers 27 | if(options.containment) { 28 | options._containers = []; 29 | var containment = options.containment; 30 | if(Object.isArray(containment)) { 31 | containment.each( function(c) { options._containers.push($(c)) }); 32 | } else { 33 | options._containers.push($(containment)); 34 | } 35 | } 36 | 37 | if(options.accept) options.accept = [options.accept].flatten(); 38 | 39 | Element.makePositioned(element); // fix IE 40 | options.element = element; 41 | 42 | this.drops.push(options); 43 | }, 44 | 45 | findDeepestChild: function(drops) { 46 | deepest = drops[0]; 47 | 48 | for (i = 1; i < drops.length; ++i) 49 | if (Element.isParent(drops[i].element, deepest.element)) 50 | deepest = drops[i]; 51 | 52 | return deepest; 53 | }, 54 | 55 | isContained: function(element, drop) { 56 | var containmentNode; 57 | if(drop.tree) { 58 | containmentNode = element.treeNode; 59 | } else { 60 | containmentNode = element.parentNode; 61 | } 62 | return drop._containers.detect(function(c) { return containmentNode == c }); 63 | }, 64 | 65 | isAffected: function(point, element, drop) { 66 | return ( 67 | (drop.element!=element) && 68 | ((!drop._containers) || 69 | this.isContained(element, drop)) && 70 | ((!drop.accept) || 71 | (Element.classNames(element).detect( 72 | function(v) { return drop.accept.include(v) } ) )) && 73 | Position.within(drop.element, point[0], point[1]) ); 74 | }, 75 | 76 | deactivate: function(drop) { 77 | if(drop.hoverclass) 78 | Element.removeClassName(drop.element, drop.hoverclass); 79 | this.last_active = null; 80 | }, 81 | 82 | activate: function(drop) { 83 | if(drop.hoverclass) 84 | Element.addClassName(drop.element, drop.hoverclass); 85 | this.last_active = drop; 86 | }, 87 | 88 | show: function(point, element) { 89 | if(!this.drops.length) return; 90 | var drop, affected = []; 91 | 92 | this.drops.each( function(drop) { 93 | if(Droppables.isAffected(point, element, drop)) 94 | affected.push(drop); 95 | }); 96 | 97 | if(affected.length>0) 98 | drop = Droppables.findDeepestChild(affected); 99 | 100 | if(this.last_active && this.last_active != drop) this.deactivate(this.last_active); 101 | if (drop) { 102 | Position.within(drop.element, point[0], point[1]); 103 | if(drop.onHover) 104 | drop.onHover(element, drop.element, Position.overlap(drop.overlap, drop.element)); 105 | 106 | if (drop != this.last_active) Droppables.activate(drop); 107 | } 108 | }, 109 | 110 | fire: function(event, element) { 111 | if(!this.last_active) return; 112 | Position.prepare(); 113 | 114 | if (this.isAffected([Event.pointerX(event), Event.pointerY(event)], element, this.last_active)) 115 | if (this.last_active.onDrop) { 116 | this.last_active.onDrop(element, this.last_active.element, event); 117 | return true; 118 | } 119 | }, 120 | 121 | reset: function() { 122 | if(this.last_active) 123 | this.deactivate(this.last_active); 124 | } 125 | }; 126 | 127 | var Draggables = { 128 | drags: [], 129 | observers: [], 130 | 131 | register: function(draggable) { 132 | if(this.drags.length == 0) { 133 | this.eventMouseUp = this.endDrag.bindAsEventListener(this); 134 | this.eventMouseMove = this.updateDrag.bindAsEventListener(this); 135 | this.eventKeypress = this.keyPress.bindAsEventListener(this); 136 | 137 | Event.observe(document, "mouseup", this.eventMouseUp); 138 | Event.observe(document, "mousemove", this.eventMouseMove); 139 | Event.observe(document, "keypress", this.eventKeypress); 140 | } 141 | this.drags.push(draggable); 142 | }, 143 | 144 | unregister: function(draggable) { 145 | this.drags = this.drags.reject(function(d) { return d==draggable }); 146 | if(this.drags.length == 0) { 147 | Event.stopObserving(document, "mouseup", this.eventMouseUp); 148 | Event.stopObserving(document, "mousemove", this.eventMouseMove); 149 | Event.stopObserving(document, "keypress", this.eventKeypress); 150 | } 151 | }, 152 | 153 | activate: function(draggable) { 154 | if(draggable.options.delay) { 155 | this._timeout = setTimeout(function() { 156 | Draggables._timeout = null; 157 | window.focus(); 158 | Draggables.activeDraggable = draggable; 159 | }.bind(this), draggable.options.delay); 160 | } else { 161 | window.focus(); // allows keypress events if window isn't currently focused, fails for Safari 162 | this.activeDraggable = draggable; 163 | } 164 | }, 165 | 166 | deactivate: function() { 167 | this.activeDraggable = null; 168 | }, 169 | 170 | updateDrag: function(event) { 171 | if(!this.activeDraggable) return; 172 | var pointer = [Event.pointerX(event), Event.pointerY(event)]; 173 | // Mozilla-based browsers fire successive mousemove events with 174 | // the same coordinates, prevent needless redrawing (moz bug?) 175 | if(this._lastPointer && (this._lastPointer.inspect() == pointer.inspect())) return; 176 | this._lastPointer = pointer; 177 | 178 | this.activeDraggable.updateDrag(event, pointer); 179 | }, 180 | 181 | endDrag: function(event) { 182 | if(this._timeout) { 183 | clearTimeout(this._timeout); 184 | this._timeout = null; 185 | } 186 | if(!this.activeDraggable) return; 187 | this._lastPointer = null; 188 | this.activeDraggable.endDrag(event); 189 | this.activeDraggable = null; 190 | }, 191 | 192 | keyPress: function(event) { 193 | if(this.activeDraggable) 194 | this.activeDraggable.keyPress(event); 195 | }, 196 | 197 | addObserver: function(observer) { 198 | this.observers.push(observer); 199 | this._cacheObserverCallbacks(); 200 | }, 201 | 202 | removeObserver: function(element) { // element instead of observer fixes mem leaks 203 | this.observers = this.observers.reject( function(o) { return o.element==element }); 204 | this._cacheObserverCallbacks(); 205 | }, 206 | 207 | notify: function(eventName, draggable, event) { // 'onStart', 'onEnd', 'onDrag' 208 | if(this[eventName+'Count'] > 0) 209 | this.observers.each( function(o) { 210 | if(o[eventName]) o[eventName](eventName, draggable, event); 211 | }); 212 | if(draggable.options[eventName]) draggable.options[eventName](draggable, event); 213 | }, 214 | 215 | _cacheObserverCallbacks: function() { 216 | ['onStart','onEnd','onDrag'].each( function(eventName) { 217 | Draggables[eventName+'Count'] = Draggables.observers.select( 218 | function(o) { return o[eventName]; } 219 | ).length; 220 | }); 221 | } 222 | }; 223 | 224 | /*--------------------------------------------------------------------------*/ 225 | 226 | var Draggable = Class.create({ 227 | initialize: function(element) { 228 | var defaults = { 229 | handle: false, 230 | reverteffect: function(element, top_offset, left_offset) { 231 | var dur = Math.sqrt(Math.abs(top_offset^2)+Math.abs(left_offset^2))*0.02; 232 | new Effect.Move(element, { x: -left_offset, y: -top_offset, duration: dur, 233 | queue: {scope:'_draggable', position:'end'} 234 | }); 235 | }, 236 | endeffect: function(element) { 237 | var toOpacity = Object.isNumber(element._opacity) ? element._opacity : 1.0; 238 | new Effect.Opacity(element, {duration:0.2, from:0.7, to:toOpacity, 239 | queue: {scope:'_draggable', position:'end'}, 240 | afterFinish: function(){ 241 | Draggable._dragging[element] = false 242 | } 243 | }); 244 | }, 245 | zindex: 1000, 246 | revert: false, 247 | quiet: false, 248 | scroll: false, 249 | scrollSensitivity: 20, 250 | scrollSpeed: 15, 251 | snap: false, // false, or xy or [x,y] or function(x,y){ return [x,y] } 252 | delay: 0 253 | }; 254 | 255 | if(!arguments[1] || Object.isUndefined(arguments[1].endeffect)) 256 | Object.extend(defaults, { 257 | starteffect: function(element) { 258 | element._opacity = Element.getOpacity(element); 259 | Draggable._dragging[element] = true; 260 | new Effect.Opacity(element, {duration:0.2, from:element._opacity, to:0.7}); 261 | } 262 | }); 263 | 264 | var options = Object.extend(defaults, arguments[1] || { }); 265 | 266 | this.element = $(element); 267 | 268 | if(options.handle && Object.isString(options.handle)) 269 | this.handle = this.element.down('.'+options.handle, 0); 270 | 271 | if(!this.handle) this.handle = $(options.handle); 272 | if(!this.handle) this.handle = this.element; 273 | 274 | if(options.scroll && !options.scroll.scrollTo && !options.scroll.outerHTML) { 275 | options.scroll = $(options.scroll); 276 | this._isScrollChild = Element.childOf(this.element, options.scroll); 277 | } 278 | 279 | Element.makePositioned(this.element); // fix IE 280 | 281 | this.options = options; 282 | this.dragging = false; 283 | 284 | this.eventMouseDown = this.initDrag.bindAsEventListener(this); 285 | Event.observe(this.handle, "mousedown", this.eventMouseDown); 286 | 287 | Draggables.register(this); 288 | }, 289 | 290 | destroy: function() { 291 | Event.stopObserving(this.handle, "mousedown", this.eventMouseDown); 292 | Draggables.unregister(this); 293 | }, 294 | 295 | currentDelta: function() { 296 | return([ 297 | parseInt(Element.getStyle(this.element,'left') || '0'), 298 | parseInt(Element.getStyle(this.element,'top') || '0')]); 299 | }, 300 | 301 | initDrag: function(event) { 302 | if(!Object.isUndefined(Draggable._dragging[this.element]) && 303 | Draggable._dragging[this.element]) return; 304 | if(Event.isLeftClick(event)) { 305 | // abort on form elements, fixes a Firefox issue 306 | var src = Event.element(event); 307 | if((tag_name = src.tagName.toUpperCase()) && ( 308 | tag_name=='INPUT' || 309 | tag_name=='SELECT' || 310 | tag_name=='OPTION' || 311 | tag_name=='BUTTON' || 312 | tag_name=='TEXTAREA')) return; 313 | 314 | var pointer = [Event.pointerX(event), Event.pointerY(event)]; 315 | var pos = this.element.cumulativeOffset(); 316 | this.offset = [0,1].map( function(i) { return (pointer[i] - pos[i]) }); 317 | 318 | Draggables.activate(this); 319 | Event.stop(event); 320 | } 321 | }, 322 | 323 | startDrag: function(event) { 324 | this.dragging = true; 325 | if(!this.delta) 326 | this.delta = this.currentDelta(); 327 | 328 | if(this.options.zindex) { 329 | this.originalZ = parseInt(Element.getStyle(this.element,'z-index') || 0); 330 | this.element.style.zIndex = this.options.zindex; 331 | } 332 | 333 | if(this.options.ghosting) { 334 | this._clone = this.element.cloneNode(true); 335 | this._originallyAbsolute = (this.element.getStyle('position') == 'absolute'); 336 | if (!this._originallyAbsolute) 337 | Position.absolutize(this.element); 338 | this.element.parentNode.insertBefore(this._clone, this.element); 339 | } 340 | 341 | if(this.options.scroll) { 342 | if (this.options.scroll == window) { 343 | var where = this._getWindowScroll(this.options.scroll); 344 | this.originalScrollLeft = where.left; 345 | this.originalScrollTop = where.top; 346 | } else { 347 | this.originalScrollLeft = this.options.scroll.scrollLeft; 348 | this.originalScrollTop = this.options.scroll.scrollTop; 349 | } 350 | } 351 | 352 | Draggables.notify('onStart', this, event); 353 | 354 | if(this.options.starteffect) this.options.starteffect(this.element); 355 | }, 356 | 357 | updateDrag: function(event, pointer) { 358 | if(!this.dragging) this.startDrag(event); 359 | 360 | if(!this.options.quiet){ 361 | Position.prepare(); 362 | Droppables.show(pointer, this.element); 363 | } 364 | 365 | Draggables.notify('onDrag', this, event); 366 | 367 | this.draw(pointer); 368 | if(this.options.change) this.options.change(this); 369 | 370 | if(this.options.scroll) { 371 | this.stopScrolling(); 372 | 373 | var p; 374 | if (this.options.scroll == window) { 375 | with(this._getWindowScroll(this.options.scroll)) { p = [ left, top, left+width, top+height ]; } 376 | } else { 377 | p = Position.page(this.options.scroll); 378 | p[0] += this.options.scroll.scrollLeft + Position.deltaX; 379 | p[1] += this.options.scroll.scrollTop + Position.deltaY; 380 | p.push(p[0]+this.options.scroll.offsetWidth); 381 | p.push(p[1]+this.options.scroll.offsetHeight); 382 | } 383 | var speed = [0,0]; 384 | if(pointer[0] < (p[0]+this.options.scrollSensitivity)) speed[0] = pointer[0]-(p[0]+this.options.scrollSensitivity); 385 | if(pointer[1] < (p[1]+this.options.scrollSensitivity)) speed[1] = pointer[1]-(p[1]+this.options.scrollSensitivity); 386 | if(pointer[0] > (p[2]-this.options.scrollSensitivity)) speed[0] = pointer[0]-(p[2]-this.options.scrollSensitivity); 387 | if(pointer[1] > (p[3]-this.options.scrollSensitivity)) speed[1] = pointer[1]-(p[3]-this.options.scrollSensitivity); 388 | this.startScrolling(speed); 389 | } 390 | 391 | // fix AppleWebKit rendering 392 | if(Prototype.Browser.WebKit) window.scrollBy(0,0); 393 | 394 | Event.stop(event); 395 | }, 396 | 397 | finishDrag: function(event, success) { 398 | this.dragging = false; 399 | 400 | if(this.options.quiet){ 401 | Position.prepare(); 402 | var pointer = [Event.pointerX(event), Event.pointerY(event)]; 403 | Droppables.show(pointer, this.element); 404 | } 405 | 406 | if(this.options.ghosting) { 407 | if (!this._originallyAbsolute) 408 | Position.relativize(this.element); 409 | delete this._originallyAbsolute; 410 | Element.remove(this._clone); 411 | this._clone = null; 412 | } 413 | 414 | var dropped = false; 415 | if(success) { 416 | dropped = Droppables.fire(event, this.element); 417 | if (!dropped) dropped = false; 418 | } 419 | if(dropped && this.options.onDropped) this.options.onDropped(this.element); 420 | Draggables.notify('onEnd', this, event); 421 | 422 | var revert = this.options.revert; 423 | if(revert && Object.isFunction(revert)) revert = revert(this.element); 424 | 425 | var d = this.currentDelta(); 426 | if(revert && this.options.reverteffect) { 427 | if (dropped == 0 || revert != 'failure') 428 | this.options.reverteffect(this.element, 429 | d[1]-this.delta[1], d[0]-this.delta[0]); 430 | } else { 431 | this.delta = d; 432 | } 433 | 434 | if(this.options.zindex) 435 | this.element.style.zIndex = this.originalZ; 436 | 437 | if(this.options.endeffect) 438 | this.options.endeffect(this.element); 439 | 440 | Draggables.deactivate(this); 441 | Droppables.reset(); 442 | }, 443 | 444 | keyPress: function(event) { 445 | if(event.keyCode!=Event.KEY_ESC) return; 446 | this.finishDrag(event, false); 447 | Event.stop(event); 448 | }, 449 | 450 | endDrag: function(event) { 451 | if(!this.dragging) return; 452 | this.stopScrolling(); 453 | this.finishDrag(event, true); 454 | Event.stop(event); 455 | }, 456 | 457 | draw: function(point) { 458 | var pos = this.element.cumulativeOffset(); 459 | if(this.options.ghosting) { 460 | var r = Position.realOffset(this.element); 461 | pos[0] += r[0] - Position.deltaX; pos[1] += r[1] - Position.deltaY; 462 | } 463 | 464 | var d = this.currentDelta(); 465 | pos[0] -= d[0]; pos[1] -= d[1]; 466 | 467 | if(this.options.scroll && (this.options.scroll != window && this._isScrollChild)) { 468 | pos[0] -= this.options.scroll.scrollLeft-this.originalScrollLeft; 469 | pos[1] -= this.options.scroll.scrollTop-this.originalScrollTop; 470 | } 471 | 472 | var p = [0,1].map(function(i){ 473 | return (point[i]-pos[i]-this.offset[i]) 474 | }.bind(this)); 475 | 476 | if(this.options.snap) { 477 | if(Object.isFunction(this.options.snap)) { 478 | p = this.options.snap(p[0],p[1],this); 479 | } else { 480 | if(Object.isArray(this.options.snap)) { 481 | p = p.map( function(v, i) { 482 | return (v/this.options.snap[i]).round()*this.options.snap[i] }.bind(this)); 483 | } else { 484 | p = p.map( function(v) { 485 | return (v/this.options.snap).round()*this.options.snap }.bind(this)); 486 | } 487 | }} 488 | 489 | var style = this.element.style; 490 | if((!this.options.constraint) || (this.options.constraint=='horizontal')) 491 | style.left = p[0] + "px"; 492 | if((!this.options.constraint) || (this.options.constraint=='vertical')) 493 | style.top = p[1] + "px"; 494 | 495 | if(style.visibility=="hidden") style.visibility = ""; // fix gecko rendering 496 | }, 497 | 498 | stopScrolling: function() { 499 | if(this.scrollInterval) { 500 | clearInterval(this.scrollInterval); 501 | this.scrollInterval = null; 502 | Draggables._lastScrollPointer = null; 503 | } 504 | }, 505 | 506 | startScrolling: function(speed) { 507 | if(!(speed[0] || speed[1])) return; 508 | this.scrollSpeed = [speed[0]*this.options.scrollSpeed,speed[1]*this.options.scrollSpeed]; 509 | this.lastScrolled = new Date(); 510 | this.scrollInterval = setInterval(this.scroll.bind(this), 10); 511 | }, 512 | 513 | scroll: function() { 514 | var current = new Date(); 515 | var delta = current - this.lastScrolled; 516 | this.lastScrolled = current; 517 | if(this.options.scroll == window) { 518 | with (this._getWindowScroll(this.options.scroll)) { 519 | if (this.scrollSpeed[0] || this.scrollSpeed[1]) { 520 | var d = delta / 1000; 521 | this.options.scroll.scrollTo( left + d*this.scrollSpeed[0], top + d*this.scrollSpeed[1] ); 522 | } 523 | } 524 | } else { 525 | this.options.scroll.scrollLeft += this.scrollSpeed[0] * delta / 1000; 526 | this.options.scroll.scrollTop += this.scrollSpeed[1] * delta / 1000; 527 | } 528 | 529 | Position.prepare(); 530 | Droppables.show(Draggables._lastPointer, this.element); 531 | Draggables.notify('onDrag', this); 532 | if (this._isScrollChild) { 533 | Draggables._lastScrollPointer = Draggables._lastScrollPointer || $A(Draggables._lastPointer); 534 | Draggables._lastScrollPointer[0] += this.scrollSpeed[0] * delta / 1000; 535 | Draggables._lastScrollPointer[1] += this.scrollSpeed[1] * delta / 1000; 536 | if (Draggables._lastScrollPointer[0] < 0) 537 | Draggables._lastScrollPointer[0] = 0; 538 | if (Draggables._lastScrollPointer[1] < 0) 539 | Draggables._lastScrollPointer[1] = 0; 540 | this.draw(Draggables._lastScrollPointer); 541 | } 542 | 543 | if(this.options.change) this.options.change(this); 544 | }, 545 | 546 | _getWindowScroll: function(w) { 547 | var T, L, W, H; 548 | with (w.document) { 549 | if (w.document.documentElement && documentElement.scrollTop) { 550 | T = documentElement.scrollTop; 551 | L = documentElement.scrollLeft; 552 | } else if (w.document.body) { 553 | T = body.scrollTop; 554 | L = body.scrollLeft; 555 | } 556 | if (w.innerWidth) { 557 | W = w.innerWidth; 558 | H = w.innerHeight; 559 | } else if (w.document.documentElement && documentElement.clientWidth) { 560 | W = documentElement.clientWidth; 561 | H = documentElement.clientHeight; 562 | } else { 563 | W = body.offsetWidth; 564 | H = body.offsetHeight; 565 | } 566 | } 567 | return { top: T, left: L, width: W, height: H }; 568 | } 569 | }); 570 | 571 | Draggable._dragging = { }; 572 | 573 | /*--------------------------------------------------------------------------*/ 574 | 575 | var SortableObserver = Class.create({ 576 | initialize: function(element, observer) { 577 | this.element = $(element); 578 | this.observer = observer; 579 | this.lastValue = Sortable.serialize(this.element); 580 | }, 581 | 582 | onStart: function() { 583 | this.lastValue = Sortable.serialize(this.element); 584 | }, 585 | 586 | onEnd: function() { 587 | Sortable.unmark(); 588 | if(this.lastValue != Sortable.serialize(this.element)) 589 | this.observer(this.element) 590 | } 591 | }); 592 | 593 | var Sortable = { 594 | SERIALIZE_RULE: /^[^_\-](?:[A-Za-z0-9\-\_]*)[_](.*)$/, 595 | 596 | sortables: { }, 597 | 598 | _findRootElement: function(element) { 599 | while (element.tagName.toUpperCase() != "BODY") { 600 | if(element.id && Sortable.sortables[element.id]) return element; 601 | element = element.parentNode; 602 | } 603 | }, 604 | 605 | options: function(element) { 606 | element = Sortable._findRootElement($(element)); 607 | if(!element) return; 608 | return Sortable.sortables[element.id]; 609 | }, 610 | 611 | destroy: function(element){ 612 | element = $(element); 613 | var s = Sortable.sortables[element.id]; 614 | 615 | if(s) { 616 | Draggables.removeObserver(s.element); 617 | s.droppables.each(function(d){ Droppables.remove(d) }); 618 | s.draggables.invoke('destroy'); 619 | 620 | delete Sortable.sortables[s.element.id]; 621 | } 622 | }, 623 | 624 | create: function(element) { 625 | element = $(element); 626 | var options = Object.extend({ 627 | element: element, 628 | tag: 'li', // assumes li children, override with tag: 'tagname' 629 | dropOnEmpty: false, 630 | tree: false, 631 | treeTag: 'ul', 632 | overlap: 'vertical', // one of 'vertical', 'horizontal' 633 | constraint: 'vertical', // one of 'vertical', 'horizontal', false 634 | containment: element, // also takes array of elements (or id's); or false 635 | handle: false, // or a CSS class 636 | only: false, 637 | delay: 0, 638 | hoverclass: null, 639 | ghosting: false, 640 | quiet: false, 641 | scroll: false, 642 | scrollSensitivity: 20, 643 | scrollSpeed: 15, 644 | format: this.SERIALIZE_RULE, 645 | 646 | // these take arrays of elements or ids and can be 647 | // used for better initialization performance 648 | elements: false, 649 | handles: false, 650 | 651 | onChange: Prototype.emptyFunction, 652 | onUpdate: Prototype.emptyFunction 653 | }, arguments[1] || { }); 654 | 655 | // clear any old sortable with same element 656 | this.destroy(element); 657 | 658 | // build options for the draggables 659 | var options_for_draggable = { 660 | revert: true, 661 | quiet: options.quiet, 662 | scroll: options.scroll, 663 | scrollSpeed: options.scrollSpeed, 664 | scrollSensitivity: options.scrollSensitivity, 665 | delay: options.delay, 666 | ghosting: options.ghosting, 667 | constraint: options.constraint, 668 | handle: options.handle }; 669 | 670 | if(options.starteffect) 671 | options_for_draggable.starteffect = options.starteffect; 672 | 673 | if(options.reverteffect) 674 | options_for_draggable.reverteffect = options.reverteffect; 675 | else 676 | if(options.ghosting) options_for_draggable.reverteffect = function(element) { 677 | element.style.top = 0; 678 | element.style.left = 0; 679 | }; 680 | 681 | if(options.endeffect) 682 | options_for_draggable.endeffect = options.endeffect; 683 | 684 | if(options.zindex) 685 | options_for_draggable.zindex = options.zindex; 686 | 687 | // build options for the droppables 688 | var options_for_droppable = { 689 | overlap: options.overlap, 690 | containment: options.containment, 691 | tree: options.tree, 692 | hoverclass: options.hoverclass, 693 | onHover: Sortable.onHover 694 | }; 695 | 696 | var options_for_tree = { 697 | onHover: Sortable.onEmptyHover, 698 | overlap: options.overlap, 699 | containment: options.containment, 700 | hoverclass: options.hoverclass 701 | }; 702 | 703 | // fix for gecko engine 704 | Element.cleanWhitespace(element); 705 | 706 | options.draggables = []; 707 | options.droppables = []; 708 | 709 | // drop on empty handling 710 | if(options.dropOnEmpty || options.tree) { 711 | Droppables.add(element, options_for_tree); 712 | options.droppables.push(element); 713 | } 714 | 715 | (options.elements || this.findElements(element, options) || []).each( function(e,i) { 716 | var handle = options.handles ? $(options.handles[i]) : 717 | (options.handle ? $(e).select('.' + options.handle)[0] : e); 718 | options.draggables.push( 719 | new Draggable(e, Object.extend(options_for_draggable, { handle: handle }))); 720 | Droppables.add(e, options_for_droppable); 721 | if(options.tree) e.treeNode = element; 722 | options.droppables.push(e); 723 | }); 724 | 725 | if(options.tree) { 726 | (Sortable.findTreeElements(element, options) || []).each( function(e) { 727 | Droppables.add(e, options_for_tree); 728 | e.treeNode = element; 729 | options.droppables.push(e); 730 | }); 731 | } 732 | 733 | // keep reference 734 | this.sortables[element.identify()] = options; 735 | 736 | // for onupdate 737 | Draggables.addObserver(new SortableObserver(element, options.onUpdate)); 738 | 739 | }, 740 | 741 | // return all suitable-for-sortable elements in a guaranteed order 742 | findElements: function(element, options) { 743 | return Element.findChildren( 744 | element, options.only, options.tree ? true : false, options.tag); 745 | }, 746 | 747 | findTreeElements: function(element, options) { 748 | return Element.findChildren( 749 | element, options.only, options.tree ? true : false, options.treeTag); 750 | }, 751 | 752 | onHover: function(element, dropon, overlap) { 753 | if(Element.isParent(dropon, element)) return; 754 | 755 | if(overlap > .33 && overlap < .66 && Sortable.options(dropon).tree) { 756 | return; 757 | } else if(overlap>0.5) { 758 | Sortable.mark(dropon, 'before'); 759 | if(dropon.previousSibling != element) { 760 | var oldParentNode = element.parentNode; 761 | element.style.visibility = "hidden"; // fix gecko rendering 762 | dropon.parentNode.insertBefore(element, dropon); 763 | if(dropon.parentNode!=oldParentNode) 764 | Sortable.options(oldParentNode).onChange(element); 765 | Sortable.options(dropon.parentNode).onChange(element); 766 | } 767 | } else { 768 | Sortable.mark(dropon, 'after'); 769 | var nextElement = dropon.nextSibling || null; 770 | if(nextElement != element) { 771 | var oldParentNode = element.parentNode; 772 | element.style.visibility = "hidden"; // fix gecko rendering 773 | dropon.parentNode.insertBefore(element, nextElement); 774 | if(dropon.parentNode!=oldParentNode) 775 | Sortable.options(oldParentNode).onChange(element); 776 | Sortable.options(dropon.parentNode).onChange(element); 777 | } 778 | } 779 | }, 780 | 781 | onEmptyHover: function(element, dropon, overlap) { 782 | var oldParentNode = element.parentNode; 783 | var droponOptions = Sortable.options(dropon); 784 | 785 | if(!Element.isParent(dropon, element)) { 786 | var index; 787 | 788 | var children = Sortable.findElements(dropon, {tag: droponOptions.tag, only: droponOptions.only}); 789 | var child = null; 790 | 791 | if(children) { 792 | var offset = Element.offsetSize(dropon, droponOptions.overlap) * (1.0 - overlap); 793 | 794 | for (index = 0; index < children.length; index += 1) { 795 | if (offset - Element.offsetSize (children[index], droponOptions.overlap) >= 0) { 796 | offset -= Element.offsetSize (children[index], droponOptions.overlap); 797 | } else if (offset - (Element.offsetSize (children[index], droponOptions.overlap) / 2) >= 0) { 798 | child = index + 1 < children.length ? children[index + 1] : null; 799 | break; 800 | } else { 801 | child = children[index]; 802 | break; 803 | } 804 | } 805 | } 806 | 807 | dropon.insertBefore(element, child); 808 | 809 | Sortable.options(oldParentNode).onChange(element); 810 | droponOptions.onChange(element); 811 | } 812 | }, 813 | 814 | unmark: function() { 815 | if(Sortable._marker) Sortable._marker.hide(); 816 | }, 817 | 818 | mark: function(dropon, position) { 819 | // mark on ghosting only 820 | var sortable = Sortable.options(dropon.parentNode); 821 | if(sortable && !sortable.ghosting) return; 822 | 823 | if(!Sortable._marker) { 824 | Sortable._marker = 825 | ($('dropmarker') || Element.extend(document.createElement('DIV'))). 826 | hide().addClassName('dropmarker').setStyle({position:'absolute'}); 827 | document.getElementsByTagName("body").item(0).appendChild(Sortable._marker); 828 | } 829 | var offsets = dropon.cumulativeOffset(); 830 | Sortable._marker.setStyle({left: offsets[0]+'px', top: offsets[1] + 'px'}); 831 | 832 | if(position=='after') 833 | if(sortable.overlap == 'horizontal') 834 | Sortable._marker.setStyle({left: (offsets[0]+dropon.clientWidth) + 'px'}); 835 | else 836 | Sortable._marker.setStyle({top: (offsets[1]+dropon.clientHeight) + 'px'}); 837 | 838 | Sortable._marker.show(); 839 | }, 840 | 841 | _tree: function(element, options, parent) { 842 | var children = Sortable.findElements(element, options) || []; 843 | 844 | for (var i = 0; i < children.length; ++i) { 845 | var match = children[i].id.match(options.format); 846 | 847 | if (!match) continue; 848 | 849 | var child = { 850 | id: encodeURIComponent(match ? match[1] : null), 851 | element: element, 852 | parent: parent, 853 | children: [], 854 | position: parent.children.length, 855 | container: $(children[i]).down(options.treeTag) 856 | }; 857 | 858 | /* Get the element containing the children and recurse over it */ 859 | if (child.container) 860 | this._tree(child.container, options, child); 861 | 862 | parent.children.push (child); 863 | } 864 | 865 | return parent; 866 | }, 867 | 868 | tree: function(element) { 869 | element = $(element); 870 | var sortableOptions = this.options(element); 871 | var options = Object.extend({ 872 | tag: sortableOptions.tag, 873 | treeTag: sortableOptions.treeTag, 874 | only: sortableOptions.only, 875 | name: element.id, 876 | format: sortableOptions.format 877 | }, arguments[1] || { }); 878 | 879 | var root = { 880 | id: null, 881 | parent: null, 882 | children: [], 883 | container: element, 884 | position: 0 885 | }; 886 | 887 | return Sortable._tree(element, options, root); 888 | }, 889 | 890 | /* Construct a [i] index for a particular node */ 891 | _constructIndex: function(node) { 892 | var index = ''; 893 | do { 894 | if (node.id) index = '[' + node.position + ']' + index; 895 | } while ((node = node.parent) != null); 896 | return index; 897 | }, 898 | 899 | sequence: function(element) { 900 | element = $(element); 901 | var options = Object.extend(this.options(element), arguments[1] || { }); 902 | 903 | return $(this.findElements(element, options) || []).map( function(item) { 904 | return item.id.match(options.format) ? item.id.match(options.format)[1] : ''; 905 | }); 906 | }, 907 | 908 | setSequence: function(element, new_sequence) { 909 | element = $(element); 910 | var options = Object.extend(this.options(element), arguments[2] || { }); 911 | 912 | var nodeMap = { }; 913 | this.findElements(element, options).each( function(n) { 914 | if (n.id.match(options.format)) 915 | nodeMap[n.id.match(options.format)[1]] = [n, n.parentNode]; 916 | n.parentNode.removeChild(n); 917 | }); 918 | 919 | new_sequence.each(function(ident) { 920 | var n = nodeMap[ident]; 921 | if (n) { 922 | n[1].appendChild(n[0]); 923 | delete nodeMap[ident]; 924 | } 925 | }); 926 | }, 927 | 928 | serialize: function(element) { 929 | element = $(element); 930 | var options = Object.extend(Sortable.options(element), arguments[1] || { }); 931 | var name = encodeURIComponent( 932 | (arguments[1] && arguments[1].name) ? arguments[1].name : element.id); 933 | 934 | if (options.tree) { 935 | return Sortable.tree(element, arguments[1]).children.map( function (item) { 936 | return [name + Sortable._constructIndex(item) + "[id]=" + 937 | encodeURIComponent(item.id)].concat(item.children.map(arguments.callee)); 938 | }).flatten().join('&'); 939 | } else { 940 | return Sortable.sequence(element, arguments[1]).map( function(item) { 941 | return name + "[]=" + encodeURIComponent(item); 942 | }).join('&'); 943 | } 944 | } 945 | }; 946 | 947 | // Returns true if child is contained within element 948 | Element.isParent = function(child, element) { 949 | if (!child.parentNode || child == element) return false; 950 | if (child.parentNode == element) return true; 951 | return Element.isParent(child.parentNode, element); 952 | }; 953 | 954 | Element.findChildren = function(element, only, recursive, tagName) { 955 | if(!element.hasChildNodes()) return null; 956 | tagName = tagName.toUpperCase(); 957 | if(only) only = [only].flatten(); 958 | var elements = []; 959 | $A(element.childNodes).each( function(e) { 960 | if(e.tagName && e.tagName.toUpperCase()==tagName && 961 | (!only || (Element.classNames(e).detect(function(v) { return only.include(v) })))) 962 | elements.push(e); 963 | if(recursive) { 964 | var grandchildren = Element.findChildren(e, only, recursive, tagName); 965 | if(grandchildren) elements.push(grandchildren); 966 | } 967 | }); 968 | 969 | return (elements.length>0 ? elements.flatten() : []); 970 | }; 971 | 972 | Element.offsetSize = function (element, type) { 973 | return element['offset' + ((type=='vertical' || type=='height') ? 'Height' : 'Width')]; 974 | }; -------------------------------------------------------------------------------- /spec/dummy/public/javascripts/effects.js: -------------------------------------------------------------------------------- 1 | // script.aculo.us effects.js v1.8.3, Thu Oct 08 11:23:33 +0200 2009 2 | 3 | // Copyright (c) 2005-2009 Thomas Fuchs (http://script.aculo.us, http://mir.aculo.us) 4 | // Contributors: 5 | // Justin Palmer (http://encytemedia.com/) 6 | // Mark Pilgrim (http://diveintomark.org/) 7 | // Martin Bialasinki 8 | // 9 | // script.aculo.us is freely distributable under the terms of an MIT-style license. 10 | // For details, see the script.aculo.us web site: http://script.aculo.us/ 11 | 12 | // converts rgb() and #xxx to #xxxxxx format, 13 | // returns self (or first argument) if not convertable 14 | String.prototype.parseColor = function() { 15 | var color = '#'; 16 | if (this.slice(0,4) == 'rgb(') { 17 | var cols = this.slice(4,this.length-1).split(','); 18 | var i=0; do { color += parseInt(cols[i]).toColorPart() } while (++i<3); 19 | } else { 20 | if (this.slice(0,1) == '#') { 21 | if (this.length==4) for(var i=1;i<4;i++) color += (this.charAt(i) + this.charAt(i)).toLowerCase(); 22 | if (this.length==7) color = this.toLowerCase(); 23 | } 24 | } 25 | return (color.length==7 ? color : (arguments[0] || this)); 26 | }; 27 | 28 | /*--------------------------------------------------------------------------*/ 29 | 30 | Element.collectTextNodes = function(element) { 31 | return $A($(element).childNodes).collect( function(node) { 32 | return (node.nodeType==3 ? node.nodeValue : 33 | (node.hasChildNodes() ? Element.collectTextNodes(node) : '')); 34 | }).flatten().join(''); 35 | }; 36 | 37 | Element.collectTextNodesIgnoreClass = function(element, className) { 38 | return $A($(element).childNodes).collect( function(node) { 39 | return (node.nodeType==3 ? node.nodeValue : 40 | ((node.hasChildNodes() && !Element.hasClassName(node,className)) ? 41 | Element.collectTextNodesIgnoreClass(node, className) : '')); 42 | }).flatten().join(''); 43 | }; 44 | 45 | Element.setContentZoom = function(element, percent) { 46 | element = $(element); 47 | element.setStyle({fontSize: (percent/100) + 'em'}); 48 | if (Prototype.Browser.WebKit) window.scrollBy(0,0); 49 | return element; 50 | }; 51 | 52 | Element.getInlineOpacity = function(element){ 53 | return $(element).style.opacity || ''; 54 | }; 55 | 56 | Element.forceRerendering = function(element) { 57 | try { 58 | element = $(element); 59 | var n = document.createTextNode(' '); 60 | element.appendChild(n); 61 | element.removeChild(n); 62 | } catch(e) { } 63 | }; 64 | 65 | /*--------------------------------------------------------------------------*/ 66 | 67 | var Effect = { 68 | _elementDoesNotExistError: { 69 | name: 'ElementDoesNotExistError', 70 | message: 'The specified DOM element does not exist, but is required for this effect to operate' 71 | }, 72 | Transitions: { 73 | linear: Prototype.K, 74 | sinoidal: function(pos) { 75 | return (-Math.cos(pos*Math.PI)/2) + .5; 76 | }, 77 | reverse: function(pos) { 78 | return 1-pos; 79 | }, 80 | flicker: function(pos) { 81 | var pos = ((-Math.cos(pos*Math.PI)/4) + .75) + Math.random()/4; 82 | return pos > 1 ? 1 : pos; 83 | }, 84 | wobble: function(pos) { 85 | return (-Math.cos(pos*Math.PI*(9*pos))/2) + .5; 86 | }, 87 | pulse: function(pos, pulses) { 88 | return (-Math.cos((pos*((pulses||5)-.5)*2)*Math.PI)/2) + .5; 89 | }, 90 | spring: function(pos) { 91 | return 1 - (Math.cos(pos * 4.5 * Math.PI) * Math.exp(-pos * 6)); 92 | }, 93 | none: function(pos) { 94 | return 0; 95 | }, 96 | full: function(pos) { 97 | return 1; 98 | } 99 | }, 100 | DefaultOptions: { 101 | duration: 1.0, // seconds 102 | fps: 100, // 100= assume 66fps max. 103 | sync: false, // true for combining 104 | from: 0.0, 105 | to: 1.0, 106 | delay: 0.0, 107 | queue: 'parallel' 108 | }, 109 | tagifyText: function(element) { 110 | var tagifyStyle = 'position:relative'; 111 | if (Prototype.Browser.IE) tagifyStyle += ';zoom:1'; 112 | 113 | element = $(element); 114 | $A(element.childNodes).each( function(child) { 115 | if (child.nodeType==3) { 116 | child.nodeValue.toArray().each( function(character) { 117 | element.insertBefore( 118 | new Element('span', {style: tagifyStyle}).update( 119 | character == ' ' ? String.fromCharCode(160) : character), 120 | child); 121 | }); 122 | Element.remove(child); 123 | } 124 | }); 125 | }, 126 | multiple: function(element, effect) { 127 | var elements; 128 | if (((typeof element == 'object') || 129 | Object.isFunction(element)) && 130 | (element.length)) 131 | elements = element; 132 | else 133 | elements = $(element).childNodes; 134 | 135 | var options = Object.extend({ 136 | speed: 0.1, 137 | delay: 0.0 138 | }, arguments[2] || { }); 139 | var masterDelay = options.delay; 140 | 141 | $A(elements).each( function(element, index) { 142 | new effect(element, Object.extend(options, { delay: index * options.speed + masterDelay })); 143 | }); 144 | }, 145 | PAIRS: { 146 | 'slide': ['SlideDown','SlideUp'], 147 | 'blind': ['BlindDown','BlindUp'], 148 | 'appear': ['Appear','Fade'] 149 | }, 150 | toggle: function(element, effect, options) { 151 | element = $(element); 152 | effect = (effect || 'appear').toLowerCase(); 153 | 154 | return Effect[ Effect.PAIRS[ effect ][ element.visible() ? 1 : 0 ] ](element, Object.extend({ 155 | queue: { position:'end', scope:(element.id || 'global'), limit: 1 } 156 | }, options || {})); 157 | } 158 | }; 159 | 160 | Effect.DefaultOptions.transition = Effect.Transitions.sinoidal; 161 | 162 | /* ------------- core effects ------------- */ 163 | 164 | Effect.ScopedQueue = Class.create(Enumerable, { 165 | initialize: function() { 166 | this.effects = []; 167 | this.interval = null; 168 | }, 169 | _each: function(iterator) { 170 | this.effects._each(iterator); 171 | }, 172 | add: function(effect) { 173 | var timestamp = new Date().getTime(); 174 | 175 | var position = Object.isString(effect.options.queue) ? 176 | effect.options.queue : effect.options.queue.position; 177 | 178 | switch(position) { 179 | case 'front': 180 | // move unstarted effects after this effect 181 | this.effects.findAll(function(e){ return e.state=='idle' }).each( function(e) { 182 | e.startOn += effect.finishOn; 183 | e.finishOn += effect.finishOn; 184 | }); 185 | break; 186 | case 'with-last': 187 | timestamp = this.effects.pluck('startOn').max() || timestamp; 188 | break; 189 | case 'end': 190 | // start effect after last queued effect has finished 191 | timestamp = this.effects.pluck('finishOn').max() || timestamp; 192 | break; 193 | } 194 | 195 | effect.startOn += timestamp; 196 | effect.finishOn += timestamp; 197 | 198 | if (!effect.options.queue.limit || (this.effects.length < effect.options.queue.limit)) 199 | this.effects.push(effect); 200 | 201 | if (!this.interval) 202 | this.interval = setInterval(this.loop.bind(this), 15); 203 | }, 204 | remove: function(effect) { 205 | this.effects = this.effects.reject(function(e) { return e==effect }); 206 | if (this.effects.length == 0) { 207 | clearInterval(this.interval); 208 | this.interval = null; 209 | } 210 | }, 211 | loop: function() { 212 | var timePos = new Date().getTime(); 213 | for(var i=0, len=this.effects.length;i= this.startOn) { 274 | if (timePos >= this.finishOn) { 275 | this.render(1.0); 276 | this.cancel(); 277 | this.event('beforeFinish'); 278 | if (this.finish) this.finish(); 279 | this.event('afterFinish'); 280 | return; 281 | } 282 | var pos = (timePos - this.startOn) / this.totalTime, 283 | frame = (pos * this.totalFrames).round(); 284 | if (frame > this.currentFrame) { 285 | this.render(pos); 286 | this.currentFrame = frame; 287 | } 288 | } 289 | }, 290 | cancel: function() { 291 | if (!this.options.sync) 292 | Effect.Queues.get(Object.isString(this.options.queue) ? 293 | 'global' : this.options.queue.scope).remove(this); 294 | this.state = 'finished'; 295 | }, 296 | event: function(eventName) { 297 | if (this.options[eventName + 'Internal']) this.options[eventName + 'Internal'](this); 298 | if (this.options[eventName]) this.options[eventName](this); 299 | }, 300 | inspect: function() { 301 | var data = $H(); 302 | for(property in this) 303 | if (!Object.isFunction(this[property])) data.set(property, this[property]); 304 | return '#'; 305 | } 306 | }); 307 | 308 | Effect.Parallel = Class.create(Effect.Base, { 309 | initialize: function(effects) { 310 | this.effects = effects || []; 311 | this.start(arguments[1]); 312 | }, 313 | update: function(position) { 314 | this.effects.invoke('render', position); 315 | }, 316 | finish: function(position) { 317 | this.effects.each( function(effect) { 318 | effect.render(1.0); 319 | effect.cancel(); 320 | effect.event('beforeFinish'); 321 | if (effect.finish) effect.finish(position); 322 | effect.event('afterFinish'); 323 | }); 324 | } 325 | }); 326 | 327 | Effect.Tween = Class.create(Effect.Base, { 328 | initialize: function(object, from, to) { 329 | object = Object.isString(object) ? $(object) : object; 330 | var args = $A(arguments), method = args.last(), 331 | options = args.length == 5 ? args[3] : null; 332 | this.method = Object.isFunction(method) ? method.bind(object) : 333 | Object.isFunction(object[method]) ? object[method].bind(object) : 334 | function(value) { object[method] = value }; 335 | this.start(Object.extend({ from: from, to: to }, options || { })); 336 | }, 337 | update: function(position) { 338 | this.method(position); 339 | } 340 | }); 341 | 342 | Effect.Event = Class.create(Effect.Base, { 343 | initialize: function() { 344 | this.start(Object.extend({ duration: 0 }, arguments[0] || { })); 345 | }, 346 | update: Prototype.emptyFunction 347 | }); 348 | 349 | Effect.Opacity = Class.create(Effect.Base, { 350 | initialize: function(element) { 351 | this.element = $(element); 352 | if (!this.element) throw(Effect._elementDoesNotExistError); 353 | // make this work on IE on elements without 'layout' 354 | if (Prototype.Browser.IE && (!this.element.currentStyle.hasLayout)) 355 | this.element.setStyle({zoom: 1}); 356 | var options = Object.extend({ 357 | from: this.element.getOpacity() || 0.0, 358 | to: 1.0 359 | }, arguments[1] || { }); 360 | this.start(options); 361 | }, 362 | update: function(position) { 363 | this.element.setOpacity(position); 364 | } 365 | }); 366 | 367 | Effect.Move = Class.create(Effect.Base, { 368 | initialize: function(element) { 369 | this.element = $(element); 370 | if (!this.element) throw(Effect._elementDoesNotExistError); 371 | var options = Object.extend({ 372 | x: 0, 373 | y: 0, 374 | mode: 'relative' 375 | }, arguments[1] || { }); 376 | this.start(options); 377 | }, 378 | setup: function() { 379 | this.element.makePositioned(); 380 | this.originalLeft = parseFloat(this.element.getStyle('left') || '0'); 381 | this.originalTop = parseFloat(this.element.getStyle('top') || '0'); 382 | if (this.options.mode == 'absolute') { 383 | this.options.x = this.options.x - this.originalLeft; 384 | this.options.y = this.options.y - this.originalTop; 385 | } 386 | }, 387 | update: function(position) { 388 | this.element.setStyle({ 389 | left: (this.options.x * position + this.originalLeft).round() + 'px', 390 | top: (this.options.y * position + this.originalTop).round() + 'px' 391 | }); 392 | } 393 | }); 394 | 395 | // for backwards compatibility 396 | Effect.MoveBy = function(element, toTop, toLeft) { 397 | return new Effect.Move(element, 398 | Object.extend({ x: toLeft, y: toTop }, arguments[3] || { })); 399 | }; 400 | 401 | Effect.Scale = Class.create(Effect.Base, { 402 | initialize: function(element, percent) { 403 | this.element = $(element); 404 | if (!this.element) throw(Effect._elementDoesNotExistError); 405 | var options = Object.extend({ 406 | scaleX: true, 407 | scaleY: true, 408 | scaleContent: true, 409 | scaleFromCenter: false, 410 | scaleMode: 'box', // 'box' or 'contents' or { } with provided values 411 | scaleFrom: 100.0, 412 | scaleTo: percent 413 | }, arguments[2] || { }); 414 | this.start(options); 415 | }, 416 | setup: function() { 417 | this.restoreAfterFinish = this.options.restoreAfterFinish || false; 418 | this.elementPositioning = this.element.getStyle('position'); 419 | 420 | this.originalStyle = { }; 421 | ['top','left','width','height','fontSize'].each( function(k) { 422 | this.originalStyle[k] = this.element.style[k]; 423 | }.bind(this)); 424 | 425 | this.originalTop = this.element.offsetTop; 426 | this.originalLeft = this.element.offsetLeft; 427 | 428 | var fontSize = this.element.getStyle('font-size') || '100%'; 429 | ['em','px','%','pt'].each( function(fontSizeType) { 430 | if (fontSize.indexOf(fontSizeType)>0) { 431 | this.fontSize = parseFloat(fontSize); 432 | this.fontSizeType = fontSizeType; 433 | } 434 | }.bind(this)); 435 | 436 | this.factor = (this.options.scaleTo - this.options.scaleFrom)/100; 437 | 438 | this.dims = null; 439 | if (this.options.scaleMode=='box') 440 | this.dims = [this.element.offsetHeight, this.element.offsetWidth]; 441 | if (/^content/.test(this.options.scaleMode)) 442 | this.dims = [this.element.scrollHeight, this.element.scrollWidth]; 443 | if (!this.dims) 444 | this.dims = [this.options.scaleMode.originalHeight, 445 | this.options.scaleMode.originalWidth]; 446 | }, 447 | update: function(position) { 448 | var currentScale = (this.options.scaleFrom/100.0) + (this.factor * position); 449 | if (this.options.scaleContent && this.fontSize) 450 | this.element.setStyle({fontSize: this.fontSize * currentScale + this.fontSizeType }); 451 | this.setDimensions(this.dims[0] * currentScale, this.dims[1] * currentScale); 452 | }, 453 | finish: function(position) { 454 | if (this.restoreAfterFinish) this.element.setStyle(this.originalStyle); 455 | }, 456 | setDimensions: function(height, width) { 457 | var d = { }; 458 | if (this.options.scaleX) d.width = width.round() + 'px'; 459 | if (this.options.scaleY) d.height = height.round() + 'px'; 460 | if (this.options.scaleFromCenter) { 461 | var topd = (height - this.dims[0])/2; 462 | var leftd = (width - this.dims[1])/2; 463 | if (this.elementPositioning == 'absolute') { 464 | if (this.options.scaleY) d.top = this.originalTop-topd + 'px'; 465 | if (this.options.scaleX) d.left = this.originalLeft-leftd + 'px'; 466 | } else { 467 | if (this.options.scaleY) d.top = -topd + 'px'; 468 | if (this.options.scaleX) d.left = -leftd + 'px'; 469 | } 470 | } 471 | this.element.setStyle(d); 472 | } 473 | }); 474 | 475 | Effect.Highlight = Class.create(Effect.Base, { 476 | initialize: function(element) { 477 | this.element = $(element); 478 | if (!this.element) throw(Effect._elementDoesNotExistError); 479 | var options = Object.extend({ startcolor: '#ffff99' }, arguments[1] || { }); 480 | this.start(options); 481 | }, 482 | setup: function() { 483 | // Prevent executing on elements not in the layout flow 484 | if (this.element.getStyle('display')=='none') { this.cancel(); return; } 485 | // Disable background image during the effect 486 | this.oldStyle = { }; 487 | if (!this.options.keepBackgroundImage) { 488 | this.oldStyle.backgroundImage = this.element.getStyle('background-image'); 489 | this.element.setStyle({backgroundImage: 'none'}); 490 | } 491 | if (!this.options.endcolor) 492 | this.options.endcolor = this.element.getStyle('background-color').parseColor('#ffffff'); 493 | if (!this.options.restorecolor) 494 | this.options.restorecolor = this.element.getStyle('background-color'); 495 | // init color calculations 496 | this._base = $R(0,2).map(function(i){ return parseInt(this.options.startcolor.slice(i*2+1,i*2+3),16) }.bind(this)); 497 | this._delta = $R(0,2).map(function(i){ return parseInt(this.options.endcolor.slice(i*2+1,i*2+3),16)-this._base[i] }.bind(this)); 498 | }, 499 | update: function(position) { 500 | this.element.setStyle({backgroundColor: $R(0,2).inject('#',function(m,v,i){ 501 | return m+((this._base[i]+(this._delta[i]*position)).round().toColorPart()); }.bind(this)) }); 502 | }, 503 | finish: function() { 504 | this.element.setStyle(Object.extend(this.oldStyle, { 505 | backgroundColor: this.options.restorecolor 506 | })); 507 | } 508 | }); 509 | 510 | Effect.ScrollTo = function(element) { 511 | var options = arguments[1] || { }, 512 | scrollOffsets = document.viewport.getScrollOffsets(), 513 | elementOffsets = $(element).cumulativeOffset(); 514 | 515 | if (options.offset) elementOffsets[1] += options.offset; 516 | 517 | return new Effect.Tween(null, 518 | scrollOffsets.top, 519 | elementOffsets[1], 520 | options, 521 | function(p){ scrollTo(scrollOffsets.left, p.round()); } 522 | ); 523 | }; 524 | 525 | /* ------------- combination effects ------------- */ 526 | 527 | Effect.Fade = function(element) { 528 | element = $(element); 529 | var oldOpacity = element.getInlineOpacity(); 530 | var options = Object.extend({ 531 | from: element.getOpacity() || 1.0, 532 | to: 0.0, 533 | afterFinishInternal: function(effect) { 534 | if (effect.options.to!=0) return; 535 | effect.element.hide().setStyle({opacity: oldOpacity}); 536 | } 537 | }, arguments[1] || { }); 538 | return new Effect.Opacity(element,options); 539 | }; 540 | 541 | Effect.Appear = function(element) { 542 | element = $(element); 543 | var options = Object.extend({ 544 | from: (element.getStyle('display') == 'none' ? 0.0 : element.getOpacity() || 0.0), 545 | to: 1.0, 546 | // force Safari to render floated elements properly 547 | afterFinishInternal: function(effect) { 548 | effect.element.forceRerendering(); 549 | }, 550 | beforeSetup: function(effect) { 551 | effect.element.setOpacity(effect.options.from).show(); 552 | }}, arguments[1] || { }); 553 | return new Effect.Opacity(element,options); 554 | }; 555 | 556 | Effect.Puff = function(element) { 557 | element = $(element); 558 | var oldStyle = { 559 | opacity: element.getInlineOpacity(), 560 | position: element.getStyle('position'), 561 | top: element.style.top, 562 | left: element.style.left, 563 | width: element.style.width, 564 | height: element.style.height 565 | }; 566 | return new Effect.Parallel( 567 | [ new Effect.Scale(element, 200, 568 | { sync: true, scaleFromCenter: true, scaleContent: true, restoreAfterFinish: true }), 569 | new Effect.Opacity(element, { sync: true, to: 0.0 } ) ], 570 | Object.extend({ duration: 1.0, 571 | beforeSetupInternal: function(effect) { 572 | Position.absolutize(effect.effects[0].element); 573 | }, 574 | afterFinishInternal: function(effect) { 575 | effect.effects[0].element.hide().setStyle(oldStyle); } 576 | }, arguments[1] || { }) 577 | ); 578 | }; 579 | 580 | Effect.BlindUp = function(element) { 581 | element = $(element); 582 | element.makeClipping(); 583 | return new Effect.Scale(element, 0, 584 | Object.extend({ scaleContent: false, 585 | scaleX: false, 586 | restoreAfterFinish: true, 587 | afterFinishInternal: function(effect) { 588 | effect.element.hide().undoClipping(); 589 | } 590 | }, arguments[1] || { }) 591 | ); 592 | }; 593 | 594 | Effect.BlindDown = function(element) { 595 | element = $(element); 596 | var elementDimensions = element.getDimensions(); 597 | return new Effect.Scale(element, 100, Object.extend({ 598 | scaleContent: false, 599 | scaleX: false, 600 | scaleFrom: 0, 601 | scaleMode: {originalHeight: elementDimensions.height, originalWidth: elementDimensions.width}, 602 | restoreAfterFinish: true, 603 | afterSetup: function(effect) { 604 | effect.element.makeClipping().setStyle({height: '0px'}).show(); 605 | }, 606 | afterFinishInternal: function(effect) { 607 | effect.element.undoClipping(); 608 | } 609 | }, arguments[1] || { })); 610 | }; 611 | 612 | Effect.SwitchOff = function(element) { 613 | element = $(element); 614 | var oldOpacity = element.getInlineOpacity(); 615 | return new Effect.Appear(element, Object.extend({ 616 | duration: 0.4, 617 | from: 0, 618 | transition: Effect.Transitions.flicker, 619 | afterFinishInternal: function(effect) { 620 | new Effect.Scale(effect.element, 1, { 621 | duration: 0.3, scaleFromCenter: true, 622 | scaleX: false, scaleContent: false, restoreAfterFinish: true, 623 | beforeSetup: function(effect) { 624 | effect.element.makePositioned().makeClipping(); 625 | }, 626 | afterFinishInternal: function(effect) { 627 | effect.element.hide().undoClipping().undoPositioned().setStyle({opacity: oldOpacity}); 628 | } 629 | }); 630 | } 631 | }, arguments[1] || { })); 632 | }; 633 | 634 | Effect.DropOut = function(element) { 635 | element = $(element); 636 | var oldStyle = { 637 | top: element.getStyle('top'), 638 | left: element.getStyle('left'), 639 | opacity: element.getInlineOpacity() }; 640 | return new Effect.Parallel( 641 | [ new Effect.Move(element, {x: 0, y: 100, sync: true }), 642 | new Effect.Opacity(element, { sync: true, to: 0.0 }) ], 643 | Object.extend( 644 | { duration: 0.5, 645 | beforeSetup: function(effect) { 646 | effect.effects[0].element.makePositioned(); 647 | }, 648 | afterFinishInternal: function(effect) { 649 | effect.effects[0].element.hide().undoPositioned().setStyle(oldStyle); 650 | } 651 | }, arguments[1] || { })); 652 | }; 653 | 654 | Effect.Shake = function(element) { 655 | element = $(element); 656 | var options = Object.extend({ 657 | distance: 20, 658 | duration: 0.5 659 | }, arguments[1] || {}); 660 | var distance = parseFloat(options.distance); 661 | var split = parseFloat(options.duration) / 10.0; 662 | var oldStyle = { 663 | top: element.getStyle('top'), 664 | left: element.getStyle('left') }; 665 | return new Effect.Move(element, 666 | { x: distance, y: 0, duration: split, afterFinishInternal: function(effect) { 667 | new Effect.Move(effect.element, 668 | { x: -distance*2, y: 0, duration: split*2, afterFinishInternal: function(effect) { 669 | new Effect.Move(effect.element, 670 | { x: distance*2, y: 0, duration: split*2, afterFinishInternal: function(effect) { 671 | new Effect.Move(effect.element, 672 | { x: -distance*2, y: 0, duration: split*2, afterFinishInternal: function(effect) { 673 | new Effect.Move(effect.element, 674 | { x: distance*2, y: 0, duration: split*2, afterFinishInternal: function(effect) { 675 | new Effect.Move(effect.element, 676 | { x: -distance, y: 0, duration: split, afterFinishInternal: function(effect) { 677 | effect.element.undoPositioned().setStyle(oldStyle); 678 | }}); }}); }}); }}); }}); }}); 679 | }; 680 | 681 | Effect.SlideDown = function(element) { 682 | element = $(element).cleanWhitespace(); 683 | // SlideDown need to have the content of the element wrapped in a container element with fixed height! 684 | var oldInnerBottom = element.down().getStyle('bottom'); 685 | var elementDimensions = element.getDimensions(); 686 | return new Effect.Scale(element, 100, Object.extend({ 687 | scaleContent: false, 688 | scaleX: false, 689 | scaleFrom: window.opera ? 0 : 1, 690 | scaleMode: {originalHeight: elementDimensions.height, originalWidth: elementDimensions.width}, 691 | restoreAfterFinish: true, 692 | afterSetup: function(effect) { 693 | effect.element.makePositioned(); 694 | effect.element.down().makePositioned(); 695 | if (window.opera) effect.element.setStyle({top: ''}); 696 | effect.element.makeClipping().setStyle({height: '0px'}).show(); 697 | }, 698 | afterUpdateInternal: function(effect) { 699 | effect.element.down().setStyle({bottom: 700 | (effect.dims[0] - effect.element.clientHeight) + 'px' }); 701 | }, 702 | afterFinishInternal: function(effect) { 703 | effect.element.undoClipping().undoPositioned(); 704 | effect.element.down().undoPositioned().setStyle({bottom: oldInnerBottom}); } 705 | }, arguments[1] || { }) 706 | ); 707 | }; 708 | 709 | Effect.SlideUp = function(element) { 710 | element = $(element).cleanWhitespace(); 711 | var oldInnerBottom = element.down().getStyle('bottom'); 712 | var elementDimensions = element.getDimensions(); 713 | return new Effect.Scale(element, window.opera ? 0 : 1, 714 | Object.extend({ scaleContent: false, 715 | scaleX: false, 716 | scaleMode: 'box', 717 | scaleFrom: 100, 718 | scaleMode: {originalHeight: elementDimensions.height, originalWidth: elementDimensions.width}, 719 | restoreAfterFinish: true, 720 | afterSetup: function(effect) { 721 | effect.element.makePositioned(); 722 | effect.element.down().makePositioned(); 723 | if (window.opera) effect.element.setStyle({top: ''}); 724 | effect.element.makeClipping().show(); 725 | }, 726 | afterUpdateInternal: function(effect) { 727 | effect.element.down().setStyle({bottom: 728 | (effect.dims[0] - effect.element.clientHeight) + 'px' }); 729 | }, 730 | afterFinishInternal: function(effect) { 731 | effect.element.hide().undoClipping().undoPositioned(); 732 | effect.element.down().undoPositioned().setStyle({bottom: oldInnerBottom}); 733 | } 734 | }, arguments[1] || { }) 735 | ); 736 | }; 737 | 738 | // Bug in opera makes the TD containing this element expand for a instance after finish 739 | Effect.Squish = function(element) { 740 | return new Effect.Scale(element, window.opera ? 1 : 0, { 741 | restoreAfterFinish: true, 742 | beforeSetup: function(effect) { 743 | effect.element.makeClipping(); 744 | }, 745 | afterFinishInternal: function(effect) { 746 | effect.element.hide().undoClipping(); 747 | } 748 | }); 749 | }; 750 | 751 | Effect.Grow = function(element) { 752 | element = $(element); 753 | var options = Object.extend({ 754 | direction: 'center', 755 | moveTransition: Effect.Transitions.sinoidal, 756 | scaleTransition: Effect.Transitions.sinoidal, 757 | opacityTransition: Effect.Transitions.full 758 | }, arguments[1] || { }); 759 | var oldStyle = { 760 | top: element.style.top, 761 | left: element.style.left, 762 | height: element.style.height, 763 | width: element.style.width, 764 | opacity: element.getInlineOpacity() }; 765 | 766 | var dims = element.getDimensions(); 767 | var initialMoveX, initialMoveY; 768 | var moveX, moveY; 769 | 770 | switch (options.direction) { 771 | case 'top-left': 772 | initialMoveX = initialMoveY = moveX = moveY = 0; 773 | break; 774 | case 'top-right': 775 | initialMoveX = dims.width; 776 | initialMoveY = moveY = 0; 777 | moveX = -dims.width; 778 | break; 779 | case 'bottom-left': 780 | initialMoveX = moveX = 0; 781 | initialMoveY = dims.height; 782 | moveY = -dims.height; 783 | break; 784 | case 'bottom-right': 785 | initialMoveX = dims.width; 786 | initialMoveY = dims.height; 787 | moveX = -dims.width; 788 | moveY = -dims.height; 789 | break; 790 | case 'center': 791 | initialMoveX = dims.width / 2; 792 | initialMoveY = dims.height / 2; 793 | moveX = -dims.width / 2; 794 | moveY = -dims.height / 2; 795 | break; 796 | } 797 | 798 | return new Effect.Move(element, { 799 | x: initialMoveX, 800 | y: initialMoveY, 801 | duration: 0.01, 802 | beforeSetup: function(effect) { 803 | effect.element.hide().makeClipping().makePositioned(); 804 | }, 805 | afterFinishInternal: function(effect) { 806 | new Effect.Parallel( 807 | [ new Effect.Opacity(effect.element, { sync: true, to: 1.0, from: 0.0, transition: options.opacityTransition }), 808 | new Effect.Move(effect.element, { x: moveX, y: moveY, sync: true, transition: options.moveTransition }), 809 | new Effect.Scale(effect.element, 100, { 810 | scaleMode: { originalHeight: dims.height, originalWidth: dims.width }, 811 | sync: true, scaleFrom: window.opera ? 1 : 0, transition: options.scaleTransition, restoreAfterFinish: true}) 812 | ], Object.extend({ 813 | beforeSetup: function(effect) { 814 | effect.effects[0].element.setStyle({height: '0px'}).show(); 815 | }, 816 | afterFinishInternal: function(effect) { 817 | effect.effects[0].element.undoClipping().undoPositioned().setStyle(oldStyle); 818 | } 819 | }, options) 820 | ); 821 | } 822 | }); 823 | }; 824 | 825 | Effect.Shrink = function(element) { 826 | element = $(element); 827 | var options = Object.extend({ 828 | direction: 'center', 829 | moveTransition: Effect.Transitions.sinoidal, 830 | scaleTransition: Effect.Transitions.sinoidal, 831 | opacityTransition: Effect.Transitions.none 832 | }, arguments[1] || { }); 833 | var oldStyle = { 834 | top: element.style.top, 835 | left: element.style.left, 836 | height: element.style.height, 837 | width: element.style.width, 838 | opacity: element.getInlineOpacity() }; 839 | 840 | var dims = element.getDimensions(); 841 | var moveX, moveY; 842 | 843 | switch (options.direction) { 844 | case 'top-left': 845 | moveX = moveY = 0; 846 | break; 847 | case 'top-right': 848 | moveX = dims.width; 849 | moveY = 0; 850 | break; 851 | case 'bottom-left': 852 | moveX = 0; 853 | moveY = dims.height; 854 | break; 855 | case 'bottom-right': 856 | moveX = dims.width; 857 | moveY = dims.height; 858 | break; 859 | case 'center': 860 | moveX = dims.width / 2; 861 | moveY = dims.height / 2; 862 | break; 863 | } 864 | 865 | return new Effect.Parallel( 866 | [ new Effect.Opacity(element, { sync: true, to: 0.0, from: 1.0, transition: options.opacityTransition }), 867 | new Effect.Scale(element, window.opera ? 1 : 0, { sync: true, transition: options.scaleTransition, restoreAfterFinish: true}), 868 | new Effect.Move(element, { x: moveX, y: moveY, sync: true, transition: options.moveTransition }) 869 | ], Object.extend({ 870 | beforeStartInternal: function(effect) { 871 | effect.effects[0].element.makePositioned().makeClipping(); 872 | }, 873 | afterFinishInternal: function(effect) { 874 | effect.effects[0].element.hide().undoClipping().undoPositioned().setStyle(oldStyle); } 875 | }, options) 876 | ); 877 | }; 878 | 879 | Effect.Pulsate = function(element) { 880 | element = $(element); 881 | var options = arguments[1] || { }, 882 | oldOpacity = element.getInlineOpacity(), 883 | transition = options.transition || Effect.Transitions.linear, 884 | reverser = function(pos){ 885 | return 1 - transition((-Math.cos((pos*(options.pulses||5)*2)*Math.PI)/2) + .5); 886 | }; 887 | 888 | return new Effect.Opacity(element, 889 | Object.extend(Object.extend({ duration: 2.0, from: 0, 890 | afterFinishInternal: function(effect) { effect.element.setStyle({opacity: oldOpacity}); } 891 | }, options), {transition: reverser})); 892 | }; 893 | 894 | Effect.Fold = function(element) { 895 | element = $(element); 896 | var oldStyle = { 897 | top: element.style.top, 898 | left: element.style.left, 899 | width: element.style.width, 900 | height: element.style.height }; 901 | element.makeClipping(); 902 | return new Effect.Scale(element, 5, Object.extend({ 903 | scaleContent: false, 904 | scaleX: false, 905 | afterFinishInternal: function(effect) { 906 | new Effect.Scale(element, 1, { 907 | scaleContent: false, 908 | scaleY: false, 909 | afterFinishInternal: function(effect) { 910 | effect.element.hide().undoClipping().setStyle(oldStyle); 911 | } }); 912 | }}, arguments[1] || { })); 913 | }; 914 | 915 | Effect.Morph = Class.create(Effect.Base, { 916 | initialize: function(element) { 917 | this.element = $(element); 918 | if (!this.element) throw(Effect._elementDoesNotExistError); 919 | var options = Object.extend({ 920 | style: { } 921 | }, arguments[1] || { }); 922 | 923 | if (!Object.isString(options.style)) this.style = $H(options.style); 924 | else { 925 | if (options.style.include(':')) 926 | this.style = options.style.parseStyle(); 927 | else { 928 | this.element.addClassName(options.style); 929 | this.style = $H(this.element.getStyles()); 930 | this.element.removeClassName(options.style); 931 | var css = this.element.getStyles(); 932 | this.style = this.style.reject(function(style) { 933 | return style.value == css[style.key]; 934 | }); 935 | options.afterFinishInternal = function(effect) { 936 | effect.element.addClassName(effect.options.style); 937 | effect.transforms.each(function(transform) { 938 | effect.element.style[transform.style] = ''; 939 | }); 940 | }; 941 | } 942 | } 943 | this.start(options); 944 | }, 945 | 946 | setup: function(){ 947 | function parseColor(color){ 948 | if (!color || ['rgba(0, 0, 0, 0)','transparent'].include(color)) color = '#ffffff'; 949 | color = color.parseColor(); 950 | return $R(0,2).map(function(i){ 951 | return parseInt( color.slice(i*2+1,i*2+3), 16 ); 952 | }); 953 | } 954 | this.transforms = this.style.map(function(pair){ 955 | var property = pair[0], value = pair[1], unit = null; 956 | 957 | if (value.parseColor('#zzzzzz') != '#zzzzzz') { 958 | value = value.parseColor(); 959 | unit = 'color'; 960 | } else if (property == 'opacity') { 961 | value = parseFloat(value); 962 | if (Prototype.Browser.IE && (!this.element.currentStyle.hasLayout)) 963 | this.element.setStyle({zoom: 1}); 964 | } else if (Element.CSS_LENGTH.test(value)) { 965 | var components = value.match(/^([\+\-]?[0-9\.]+)(.*)$/); 966 | value = parseFloat(components[1]); 967 | unit = (components.length == 3) ? components[2] : null; 968 | } 969 | 970 | var originalValue = this.element.getStyle(property); 971 | return { 972 | style: property.camelize(), 973 | originalValue: unit=='color' ? parseColor(originalValue) : parseFloat(originalValue || 0), 974 | targetValue: unit=='color' ? parseColor(value) : value, 975 | unit: unit 976 | }; 977 | }.bind(this)).reject(function(transform){ 978 | return ( 979 | (transform.originalValue == transform.targetValue) || 980 | ( 981 | transform.unit != 'color' && 982 | (isNaN(transform.originalValue) || isNaN(transform.targetValue)) 983 | ) 984 | ); 985 | }); 986 | }, 987 | update: function(position) { 988 | var style = { }, transform, i = this.transforms.length; 989 | while(i--) 990 | style[(transform = this.transforms[i]).style] = 991 | transform.unit=='color' ? '#'+ 992 | (Math.round(transform.originalValue[0]+ 993 | (transform.targetValue[0]-transform.originalValue[0])*position)).toColorPart() + 994 | (Math.round(transform.originalValue[1]+ 995 | (transform.targetValue[1]-transform.originalValue[1])*position)).toColorPart() + 996 | (Math.round(transform.originalValue[2]+ 997 | (transform.targetValue[2]-transform.originalValue[2])*position)).toColorPart() : 998 | (transform.originalValue + 999 | (transform.targetValue - transform.originalValue) * position).toFixed(3) + 1000 | (transform.unit === null ? '' : transform.unit); 1001 | this.element.setStyle(style, true); 1002 | } 1003 | }); 1004 | 1005 | Effect.Transform = Class.create({ 1006 | initialize: function(tracks){ 1007 | this.tracks = []; 1008 | this.options = arguments[1] || { }; 1009 | this.addTracks(tracks); 1010 | }, 1011 | addTracks: function(tracks){ 1012 | tracks.each(function(track){ 1013 | track = $H(track); 1014 | var data = track.values().first(); 1015 | this.tracks.push($H({ 1016 | ids: track.keys().first(), 1017 | effect: Effect.Morph, 1018 | options: { style: data } 1019 | })); 1020 | }.bind(this)); 1021 | return this; 1022 | }, 1023 | play: function(){ 1024 | return new Effect.Parallel( 1025 | this.tracks.map(function(track){ 1026 | var ids = track.get('ids'), effect = track.get('effect'), options = track.get('options'); 1027 | var elements = [$(ids) || $$(ids)].flatten(); 1028 | return elements.map(function(e){ return new effect(e, Object.extend({ sync:true }, options)) }); 1029 | }).flatten(), 1030 | this.options 1031 | ); 1032 | } 1033 | }); 1034 | 1035 | Element.CSS_PROPERTIES = $w( 1036 | 'backgroundColor backgroundPosition borderBottomColor borderBottomStyle ' + 1037 | 'borderBottomWidth borderLeftColor borderLeftStyle borderLeftWidth ' + 1038 | 'borderRightColor borderRightStyle borderRightWidth borderSpacing ' + 1039 | 'borderTopColor borderTopStyle borderTopWidth bottom clip color ' + 1040 | 'fontSize fontWeight height left letterSpacing lineHeight ' + 1041 | 'marginBottom marginLeft marginRight marginTop markerOffset maxHeight '+ 1042 | 'maxWidth minHeight minWidth opacity outlineColor outlineOffset ' + 1043 | 'outlineWidth paddingBottom paddingLeft paddingRight paddingTop ' + 1044 | 'right textIndent top width wordSpacing zIndex'); 1045 | 1046 | Element.CSS_LENGTH = /^(([\+\-]?[0-9\.]+)(em|ex|px|in|cm|mm|pt|pc|\%))|0$/; 1047 | 1048 | String.__parseStyleElement = document.createElement('div'); 1049 | String.prototype.parseStyle = function(){ 1050 | var style, styleRules = $H(); 1051 | if (Prototype.Browser.WebKit) 1052 | style = new Element('div',{style:this}).style; 1053 | else { 1054 | String.__parseStyleElement.innerHTML = '
    '; 1055 | style = String.__parseStyleElement.childNodes[0].style; 1056 | } 1057 | 1058 | Element.CSS_PROPERTIES.each(function(property){ 1059 | if (style[property]) styleRules.set(property, style[property]); 1060 | }); 1061 | 1062 | if (Prototype.Browser.IE && this.include('opacity')) 1063 | styleRules.set('opacity', this.match(/opacity:\s*((?:0|1)?(?:\.\d*)?)/)[1]); 1064 | 1065 | return styleRules; 1066 | }; 1067 | 1068 | if (document.defaultView && document.defaultView.getComputedStyle) { 1069 | Element.getStyles = function(element) { 1070 | var css = document.defaultView.getComputedStyle($(element), null); 1071 | return Element.CSS_PROPERTIES.inject({ }, function(styles, property) { 1072 | styles[property] = css[property]; 1073 | return styles; 1074 | }); 1075 | }; 1076 | } else { 1077 | Element.getStyles = function(element) { 1078 | element = $(element); 1079 | var css = element.currentStyle, styles; 1080 | styles = Element.CSS_PROPERTIES.inject({ }, function(results, property) { 1081 | results[property] = css[property]; 1082 | return results; 1083 | }); 1084 | if (!styles.opacity) styles.opacity = element.getOpacity(); 1085 | return styles; 1086 | }; 1087 | } 1088 | 1089 | Effect.Methods = { 1090 | morph: function(element, style) { 1091 | element = $(element); 1092 | new Effect.Morph(element, Object.extend({ style: style }, arguments[2] || { })); 1093 | return element; 1094 | }, 1095 | visualEffect: function(element, effect, options) { 1096 | element = $(element); 1097 | var s = effect.dasherize().camelize(), klass = s.charAt(0).toUpperCase() + s.substring(1); 1098 | new Effect[klass](element, options); 1099 | return element; 1100 | }, 1101 | highlight: function(element, options) { 1102 | element = $(element); 1103 | new Effect.Highlight(element, options); 1104 | return element; 1105 | } 1106 | }; 1107 | 1108 | $w('fade appear grow shrink fold blindUp blindDown slideUp slideDown '+ 1109 | 'pulsate shake puff squish switchOff dropOut').each( 1110 | function(effect) { 1111 | Effect.Methods[effect] = function(element, options){ 1112 | element = $(element); 1113 | Effect[effect.charAt(0).toUpperCase() + effect.substring(1)](element, options); 1114 | return element; 1115 | }; 1116 | } 1117 | ); 1118 | 1119 | $w('getInlineOpacity forceRerendering setContentZoom collectTextNodes collectTextNodesIgnoreClass getStyles').each( 1120 | function(f) { Effect.Methods[f] = Element[f]; } 1121 | ); 1122 | 1123 | Element.addMethods(Effect.Methods); -------------------------------------------------------------------------------- /spec/dummy/public/javascripts/rails.js: -------------------------------------------------------------------------------- 1 | (function() { 2 | // Technique from Juriy Zaytsev 3 | // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/ 4 | function isEventSupported(eventName) { 5 | var el = document.createElement('div'); 6 | eventName = 'on' + eventName; 7 | var isSupported = (eventName in el); 8 | if (!isSupported) { 9 | el.setAttribute(eventName, 'return;'); 10 | isSupported = typeof el[eventName] == 'function'; 11 | } 12 | el = null; 13 | return isSupported; 14 | } 15 | 16 | function isForm(element) { 17 | return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM' 18 | } 19 | 20 | function isInput(element) { 21 | if (Object.isElement(element)) { 22 | var name = element.nodeName.toUpperCase() 23 | return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA' 24 | } 25 | else return false 26 | } 27 | 28 | var submitBubbles = isEventSupported('submit'), 29 | changeBubbles = isEventSupported('change') 30 | 31 | if (!submitBubbles || !changeBubbles) { 32 | // augment the Event.Handler class to observe custom events when needed 33 | Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap( 34 | function(init, element, eventName, selector, callback) { 35 | init(element, eventName, selector, callback) 36 | // is the handler being attached to an element that doesn't support this event? 37 | if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) || 38 | (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) { 39 | // "submit" => "emulated:submit" 40 | this.eventName = 'emulated:' + this.eventName 41 | } 42 | } 43 | ) 44 | } 45 | 46 | if (!submitBubbles) { 47 | // discover forms on the page by observing focus events which always bubble 48 | document.on('focusin', 'form', function(focusEvent, form) { 49 | // special handler for the real "submit" event (one-time operation) 50 | if (!form.retrieve('emulated:submit')) { 51 | form.on('submit', function(submitEvent) { 52 | var emulated = form.fire('emulated:submit', submitEvent, true) 53 | // if custom event received preventDefault, cancel the real one too 54 | if (emulated.returnValue === false) submitEvent.preventDefault() 55 | }) 56 | form.store('emulated:submit', true) 57 | } 58 | }) 59 | } 60 | 61 | if (!changeBubbles) { 62 | // discover form inputs on the page 63 | document.on('focusin', 'input, select, texarea', function(focusEvent, input) { 64 | // special handler for real "change" events 65 | if (!input.retrieve('emulated:change')) { 66 | input.on('change', function(changeEvent) { 67 | input.fire('emulated:change', changeEvent, true) 68 | }) 69 | input.store('emulated:change', true) 70 | } 71 | }) 72 | } 73 | 74 | function handleRemote(element) { 75 | var method, url, params; 76 | 77 | var event = element.fire("ajax:before"); 78 | if (event.stopped) return false; 79 | 80 | if (element.tagName.toLowerCase() === 'form') { 81 | method = element.readAttribute('method') || 'post'; 82 | url = element.readAttribute('action'); 83 | params = element.serialize(); 84 | } else { 85 | method = element.readAttribute('data-method') || 'get'; 86 | url = element.readAttribute('href'); 87 | params = {}; 88 | } 89 | 90 | new Ajax.Request(url, { 91 | method: method, 92 | parameters: params, 93 | evalScripts: true, 94 | 95 | onComplete: function(request) { element.fire("ajax:complete", request); }, 96 | onSuccess: function(request) { element.fire("ajax:success", request); }, 97 | onFailure: function(request) { element.fire("ajax:failure", request); } 98 | }); 99 | 100 | element.fire("ajax:after"); 101 | } 102 | 103 | function handleMethod(element) { 104 | var method = element.readAttribute('data-method'), 105 | url = element.readAttribute('href'), 106 | csrf_param = $$('meta[name=csrf-param]')[0], 107 | csrf_token = $$('meta[name=csrf-token]')[0]; 108 | 109 | var form = new Element('form', { method: "POST", action: url, style: "display: none;" }); 110 | element.parentNode.insert(form); 111 | 112 | if (method !== 'post') { 113 | var field = new Element('input', { type: 'hidden', name: '_method', value: method }); 114 | form.insert(field); 115 | } 116 | 117 | if (csrf_param) { 118 | var param = csrf_param.readAttribute('content'), 119 | token = csrf_token.readAttribute('content'), 120 | field = new Element('input', { type: 'hidden', name: param, value: token }); 121 | form.insert(field); 122 | } 123 | 124 | form.submit(); 125 | } 126 | 127 | 128 | document.on("click", "*[data-confirm]", function(event, element) { 129 | var message = element.readAttribute('data-confirm'); 130 | if (!confirm(message)) event.stop(); 131 | }); 132 | 133 | document.on("click", "a[data-remote]", function(event, element) { 134 | if (event.stopped) return; 135 | handleRemote(element); 136 | event.stop(); 137 | }); 138 | 139 | document.on("click", "a[data-method]", function(event, element) { 140 | if (event.stopped) return; 141 | handleMethod(element); 142 | event.stop(); 143 | }); 144 | 145 | document.on("submit", function(event) { 146 | var element = event.findElement(), 147 | message = element.readAttribute('data-confirm'); 148 | if (message && !confirm(message)) { 149 | event.stop(); 150 | return false; 151 | } 152 | 153 | var inputs = element.select("input[type=submit][data-disable-with]"); 154 | inputs.each(function(input) { 155 | input.disabled = true; 156 | input.writeAttribute('data-original-value', input.value); 157 | input.value = input.readAttribute('data-disable-with'); 158 | }); 159 | 160 | var element = event.findElement("form[data-remote]"); 161 | if (element) { 162 | handleRemote(element); 163 | event.stop(); 164 | } 165 | }); 166 | 167 | document.on("ajax:after", "form", function(event, element) { 168 | var inputs = element.select("input[type=submit][disabled=true][data-disable-with]"); 169 | inputs.each(function(input) { 170 | input.value = input.readAttribute('data-original-value'); 171 | input.removeAttribute('data-original-value'); 172 | input.disabled = false; 173 | }); 174 | }); 175 | })(); 176 | -------------------------------------------------------------------------------- /spec/dummy/public/robots.txt: -------------------------------------------------------------------------------- 1 | # See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file 2 | # 3 | # To ban all spiders from the entire site uncomment the next two lines: 4 | # User-Agent: * 5 | # Disallow: / 6 | -------------------------------------------------------------------------------- /spec/dummy/public/stylesheets/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/paulca/configurable_engine/5f7829bfbea5700f69d8c13bc795093d6db20fd9/spec/dummy/public/stylesheets/.gitkeep -------------------------------------------------------------------------------- /spec/dummy/script/rails: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | # frozen_string_literal: true 3 | 4 | # This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application. 5 | 6 | APP_PATH = File.expand_path('../config/application', __dir__) 7 | require File.expand_path('../config/boot', __dir__) 8 | require 'rails/commands' 9 | -------------------------------------------------------------------------------- /spec/dummy/vendor/plugins/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/paulca/configurable_engine/5f7829bfbea5700f69d8c13bc795093d6db20fd9/spec/dummy/vendor/plugins/.gitkeep -------------------------------------------------------------------------------- /spec/models/configurable_spec.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | require 'spec_helper' 4 | 5 | describe Configurable do 6 | describe '.create' do 7 | it 'requires a key' do 8 | expect(Configurable.create(name: nil)).to have(1).error_on(:name) 9 | end 10 | 11 | it 'requires a unique key' do 12 | Configurable.create!(name: 'notify_email') 13 | expect(Configurable.create(name: 'notify_email')).to have(1).error_on(:name) 14 | end 15 | end 16 | 17 | describe '.keys' do 18 | it 'collects the keys' do 19 | expect(Configurable.keys).to eq %w[accept_applications 20 | conversion_rate 21 | important_date 22 | important_number 23 | log_out_sso 24 | long_list 25 | notify_email] 26 | end 27 | end 28 | 29 | describe '.[]=' do 30 | context 'with no saved value' do 31 | it 'creates a new entry' do 32 | expect do 33 | Configurable[:notify_email] = 'john@example.com' 34 | end.to change(Configurable, :count).from(0).to(1) 35 | expect(Configurable.find_by_name('notify_email').value).to eq 'john@example.com' 36 | end 37 | end 38 | 39 | context 'with a saved value' do 40 | before do 41 | Configurable.create! do |c| 42 | c.name = 'notify_email' 43 | c.value = 'paul@rslw.com' 44 | end 45 | end 46 | 47 | it 'updates the existing value' do 48 | expect do 49 | Configurable[:notify_email] = 'john@example.com' 50 | end.not_to change Configurable, :count 51 | expect(Configurable.find_by_name('notify_email').value).to eq 'john@example.com' 52 | end 53 | end 54 | 55 | context 'with a list value' do 56 | it 'updates the existing value' do 57 | new_list = [%w[Four 4], %w[Five 5], %w[Six 6]] 58 | Configurable[:long_list] = new_list 59 | expect(Configurable.long_list).to eq new_list 60 | end 61 | end 62 | 63 | context 'with a date value' do 64 | it 'updates the existing value' do 65 | new_date = Date.today 66 | Configurable[:important_date] = new_date 67 | expect(Configurable.important_date).to eq new_date 68 | end 69 | end 70 | end 71 | 72 | describe '.[]' do 73 | context 'with no saved value' do 74 | it 'shoud pick up the default value' do 75 | expect(Configurable[:notify_email]).to eq 'mreider@engineyard.com' 76 | end 77 | end 78 | 79 | context 'with a saved value' do 80 | before do 81 | Configurable.create!(name: 'notify_email', value: 'paul@rslw.com') 82 | end 83 | 84 | it 'finds the new value' do 85 | expect(Configurable[:notify_email]).to eq 'paul@rslw.com' 86 | end 87 | end 88 | 89 | context 'with a boolean value' do 90 | before do 91 | Configurable.create!(name: 'log_out_sso', value: true) 92 | end 93 | 94 | it 'typecasts the new value' do 95 | expect(Configurable[:log_out_sso]).to be true 96 | expect(Configurable.log_out_sso?).to be true 97 | end 98 | end 99 | 100 | context 'with a default boolean of true and a configuration set to false' do 101 | before do 102 | Configurable.create!(name: 'accept_applications', value: false) 103 | end 104 | 105 | it 'typecasts the new value' do 106 | expect(Configurable[:accept_applications]).to be false 107 | expect(Configurable.accept_applications).to be false 108 | end 109 | end 110 | 111 | context 'with a decimal value' do 112 | before do 113 | Configurable.create!(name: 'conversion_rate', value: 1.2) 114 | end 115 | 116 | it 'typecasts the value' do 117 | expect(Configurable.conversion_rate).to eq BigDecimal('1.2') 118 | end 119 | end 120 | 121 | context 'with an integer value' do 122 | before do 123 | Configurable.create!(name: 'important_number', value: 100) 124 | end 125 | 126 | it 'typecasts the value' do 127 | expect(Configurable.important_number).to eq 100 128 | end 129 | end 130 | 131 | context 'with a date value' do 132 | before do 133 | Configurable.create!(name: 'important_date', value: '2016-11-23') 134 | end 135 | 136 | it 'typecasts the value' do 137 | expect(Configurable.important_date).to eq Date.parse('2016-11-23') 138 | end 139 | end 140 | 141 | context 'with a list value' do 142 | context 'default' do 143 | it 'defaults to a list' do 144 | expect(Configurable.long_list).to eq [['One', 1], ['Two', 2], ['Three', 3]] 145 | end 146 | end 147 | 148 | context 'with a value' do 149 | before do 150 | Configurable.create!({ name: 'long_list', 151 | value: "Paul,7\nCiara,8\nBrian,9" }) 152 | end 153 | 154 | it 'updates the list' do 155 | expect(Configurable.long_list).to eq [%w[Paul 7], 156 | %w[Ciara 8], 157 | %w[Brian 9]] 158 | end 159 | end 160 | end 161 | end 162 | 163 | describe '.method_missing' do 164 | it "raises an error if a key doesn't exist" do 165 | expect { Configurable.nonsense }.to raise_error(NoMethodError) 166 | end 167 | 168 | it 'returns the correct value' do 169 | expect(Configurable.notify_email).to eq 'mreider@engineyard.com' 170 | end 171 | 172 | it 'assigns the correct value' do 173 | Configurable.notify_email = 'john@example.com' 174 | expect(Configurable.notify_email).to eq 'john@example.com' 175 | end 176 | end 177 | end 178 | -------------------------------------------------------------------------------- /spec/spec_helper.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | # This file is copied to spec/ when you run 'rails generate rspec:install' 4 | ENV['RAILS_ENV'] ||= 'test' 5 | require File.expand_path('dummy/config/environment', __dir__) 6 | require 'rspec/rails' 7 | require 'rspec/collection_matchers' 8 | 9 | # Requires supporting ruby files with custom matchers and macros, etc, 10 | # in spec/support/ and its subdirectories. 11 | Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f } 12 | 13 | RSpec.configure do |config| 14 | # == Mock Framework 15 | # 16 | # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line: 17 | # 18 | # config.mock_with :mocha 19 | # config.mock_with :flexmock 20 | # config.mock_with :rr 21 | config.mock_with :rspec 22 | 23 | # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures 24 | config.fixture_path = "#{Rails.root}/spec/fixtures" 25 | 26 | # If you're not using ActiveRecord, or you'd prefer not to run each of your 27 | # examples within a transaction, remove the following line or assign false 28 | # instead of true. 29 | config.use_transactional_fixtures = true 30 | end 31 | --------------------------------------------------------------------------------