alki-rails 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 0be7330439afdd21ac9167436a58a353f82d08ba
4
+ data.tar.gz: 4950b9abd7e6c052e06a5325358e7c02f56a9fab
5
+ SHA512:
6
+ metadata.gz: 25bc1d6905b30601be005013e8bab059d2915fc162b5dd4db0752c9575397dae3385bd7e4a6e6706fd7e138a1ae0312d83655bbe1b2dfae47992a26841214460
7
+ data.tar.gz: 4bf81f9a0cd40750c8c69848a0ca39d5526502f8477932e67bb76581d82fbb471499bdbe14a4d76ff80dcd51fd2857fd57d3567cd6ea5942fc68afb69fec1b63
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at matt.edlefsen@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in alki-rails.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Matt Edlefsen
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,74 @@
1
+ # Alki::Rails
2
+
3
+ Rails integration for Alki! Allows easily using Alki in your Rails project. Alki is a dependency injection and program organization framework.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your Rails application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'alki-rails'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Create a `config/alki` directory and then create an empty Alki Assembly definition in an `assembly.rb` file inside that.
18
+
19
+ .config/alki/assembly.rb
20
+ ```ruby
21
+ Alki do
22
+
23
+ end
24
+ ```
25
+
26
+ Finally, add the following to your ApplicationController class:
27
+
28
+ ```ruby
29
+ include Alki::Rails
30
+ ```
31
+
32
+ ## Usage
33
+
34
+ Element defined in your Assembly definition will be callable directly from your assembly:
35
+
36
+ .config/alki/assembly.rb
37
+ ```ruby
38
+ Alki do
39
+ group :settings do
40
+ set :msg, "Hello World"
41
+ end
42
+ end
43
+ ```
44
+
45
+ .app/controllers/home_controller.rb
46
+ ```ruby
47
+ class HomeController < ApplicationController
48
+ def show
49
+ @msg = settings.msg
50
+ end
51
+ end
52
+ ```
53
+
54
+ Elements can also be accessed in the Rails console, or anywhere else in your Rails application, via Alki::Rails:
55
+
56
+ .Rails Console
57
+ ```
58
+ 2.3.2 :001 > Alki::Rails.settings.msg
59
+ => "Hello World"
60
+ ```
61
+
62
+ Alki will automatically add your projects `lib` directory to the ruby load path, so you can require files from there directly. It also will handle auto-reloading files in lib.
63
+
64
+ See [here](https://github.com/alki-project/alki) for more documentation on how to use Alki.
65
+
66
+ ## Contributing
67
+
68
+ Bug reports and pull requests are welcome on GitHub at https://github.com/alki-project/alki-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
69
+
70
+
71
+ ## License
72
+
73
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
74
+
data/Rakefile ADDED
@@ -0,0 +1,2 @@
1
+ require "bundler/gem_tasks"
2
+ task :default => :spec
@@ -0,0 +1,27 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'alki/rails/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "alki-rails"
8
+ spec.version = Alki::Rails::VERSION
9
+ spec.authors = ["Matt Edlefsen"]
10
+ spec.email = ["matt.edlefsen@gmail.com"]
11
+
12
+ spec.summary = %q{Rails integration for Alki}
13
+ spec.homepage = "https://github.com/alki-project/alki-rails"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
17
+ f.match(%r{^(test|spec|features)/})
18
+ end
19
+ spec.bindir = "exe"
20
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
21
+ spec.require_paths = ["lib"]
22
+
23
+ spec.add_development_dependency "bundler", "~> 1.13"
24
+ spec.add_development_dependency "rake", "~> 10.0"
25
+ spec.add_dependency "alki", "~> 0.9", ">= 0.9.1"
26
+ spec.add_dependency "alki-reload", "~> 0.1"
27
+ end
@@ -0,0 +1,5 @@
1
+ module Alki
2
+ module Rails
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
data/lib/alki/rails.rb ADDED
@@ -0,0 +1,41 @@
1
+ require 'alki'
2
+
3
+ module Alki
4
+ module Rails
5
+ module Instance
6
+ def self.build_assembly
7
+ unless File.exist? ::Rails.root.join('config','alki','assembly.rb').to_s
8
+ raise "Alki::Rails requires a config/alki/assembly.rb file to exist!!"
9
+ end
10
+ Alki.create_assembly config_dir: ::Rails.root.join('config','alki').to_s, name: 'alki_rails_assembly'
11
+ end
12
+
13
+ def self.alki_module
14
+ @module ||= build_assembly
15
+ end
16
+
17
+ def self.instance
18
+ @instance ||= alki_module.new do
19
+ mount :reloader, 'alki/reload' do
20
+ set(:root_dir) { ::Rails.root }
21
+ set(:watch) { !::Rails.application.config.cache_classes }
22
+ end
23
+ end
24
+ end
25
+ end
26
+
27
+ def respond_to_missing?(name,_include_all)
28
+ Alki::Rails::Instance.instance.respond_to? name
29
+ end
30
+
31
+ def method_missing(name,*args,&blk)
32
+ if Alki::Rails::Instance.instance.respond_to? name
33
+ Alki::Rails::Instance.instance.send name, *args, &blk
34
+ else
35
+ super
36
+ end
37
+ end
38
+
39
+ extend self
40
+ end
41
+ end
data/lib/alki-rails.rb ADDED
@@ -0,0 +1 @@
1
+ require 'alki/rails'
metadata ADDED
@@ -0,0 +1,116 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: alki-rails
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Matt Edlefsen
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-12-20 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.13'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.13'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: alki
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '0.9'
48
+ - - ">="
49
+ - !ruby/object:Gem::Version
50
+ version: 0.9.1
51
+ type: :runtime
52
+ prerelease: false
53
+ version_requirements: !ruby/object:Gem::Requirement
54
+ requirements:
55
+ - - "~>"
56
+ - !ruby/object:Gem::Version
57
+ version: '0.9'
58
+ - - ">="
59
+ - !ruby/object:Gem::Version
60
+ version: 0.9.1
61
+ - !ruby/object:Gem::Dependency
62
+ name: alki-reload
63
+ requirement: !ruby/object:Gem::Requirement
64
+ requirements:
65
+ - - "~>"
66
+ - !ruby/object:Gem::Version
67
+ version: '0.1'
68
+ type: :runtime
69
+ prerelease: false
70
+ version_requirements: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - "~>"
73
+ - !ruby/object:Gem::Version
74
+ version: '0.1'
75
+ description:
76
+ email:
77
+ - matt.edlefsen@gmail.com
78
+ executables: []
79
+ extensions: []
80
+ extra_rdoc_files: []
81
+ files:
82
+ - ".gitignore"
83
+ - CODE_OF_CONDUCT.md
84
+ - Gemfile
85
+ - LICENSE.txt
86
+ - README.md
87
+ - Rakefile
88
+ - alki-rails.gemspec
89
+ - lib/alki-rails.rb
90
+ - lib/alki/rails.rb
91
+ - lib/alki/rails/version.rb
92
+ homepage: https://github.com/alki-project/alki-rails
93
+ licenses:
94
+ - MIT
95
+ metadata: {}
96
+ post_install_message:
97
+ rdoc_options: []
98
+ require_paths:
99
+ - lib
100
+ required_ruby_version: !ruby/object:Gem::Requirement
101
+ requirements:
102
+ - - ">="
103
+ - !ruby/object:Gem::Version
104
+ version: '0'
105
+ required_rubygems_version: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - ">="
108
+ - !ruby/object:Gem::Version
109
+ version: '0'
110
+ requirements: []
111
+ rubyforge_project:
112
+ rubygems_version: 2.5.2
113
+ signing_key:
114
+ specification_version: 4
115
+ summary: Rails integration for Alki
116
+ test_files: []