app_root 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a5b0f8d107b7aab6695951a9f8c46cd369277df
-  data.tar.gz: 431d640431dc975213627d48e3c69566b850d4cf
+  metadata.gz: d9c08256cfa27cf58ff029a01e9d1f6a962b6905
+  data.tar.gz: c3535b0dc02bbfb66ca3c9423738cf120a4d78bd
 SHA512:
-  metadata.gz: db1c43bcf2c7d9ac9d5ee6aeecbcea188b57a86eb4cad7dcbeb2b86ef392a95f5e71032aaed6d1dd49573aa197f282f9484e3808058711a979d1175e0a7d03c9
-  data.tar.gz: d0cbb63764909447b0921bbc54dea193cb4a6c138527334c3e60c5bfe90e82916d69ad6db02dad983fe202bc69b6a6eab5ea7b9f74cee662b273ebb67546e757
+  metadata.gz: 0965e22a22633b3f8f268a48b3e2cd29a111b7fe7e2836eca807759a83782647fc12fa3b6d5b89d284d8e5e399621212a4b8734a500e8742fb3c7f164a1c8e86
+  data.tar.gz: 44da995349f3c0882cc77b96d446c97eea6d722389771d0e0c4957cc800c45fb5ac9ba531ccb196aa23804bdbf3b3bc5a7907ff9781a69cda07243d0141b474d

data/README.md

@@ -18,6 +18,7 @@ Or install it yourself as:
     $ gem install app_root
 
 ## Usage
+### Basic Usage
 ```ruby
 require "app_root"
 
@@ -25,6 +26,29 @@ puts AppRoot.path("config.ru")
 #=> /path/to/your/application/root
 ```
 
+### Integrate Your App
+Using AppRoot.path:
+
+```ruby
+class MyApp
+  def self.root
+    AppRoot.path("config.ru")
+  end
+end
+```
+
+Including AppRoot:
+
+```ruby
+class MyApp
+  include AppRoot
+
+  def self.root_flag
+    "config.ru"
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/app_root.rb

@@ -1,7 +1,18 @@
-class AppRoot
+module AppRoot
   class << self
     attr_writer :default_path
 
+    def find_with_flag(flag)
+      find_root_with_flag(flag, called_from)
+    end
+    alias_method :path, :find_with_flag
+
+    def included(base)
+      base.extend(ClassMethods)
+    end
+
+    private
+
     def called_from
       File.dirname(
         caller_locations.map do |l|
@@ -31,10 +42,17 @@ class AppRoot
 
       Pathname.new(File.realpath(root))
     end
+  end
 
-    def find_with_flag(flag)
-      find_root_with_flag(flag, called_from)
+  module ClassMethods
+    def root
+      AppRoot.find_with_flag(root_flag)
+    end
+
+    private
+
+    def root_flag
+      raise(NotImplementedError, "You must implement #{self}.#{__method__}")
     end
-    alias_method :path, :find_with_flag
   end
 end

data/lib/app_root/version.rb

@@ -1,3 +1,3 @@
-class AppRoot
-  VERSION = "0.1.0"
+module AppRoot
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_root
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - nownabe