Skip to content
Browse files

do not include Storage in the 2.0.0 release

  • Loading branch information...
1 parent 198e53f commit bc957faa09ed0210ddce64482127dcd8c92f8e63 @dominikh dominikh committed Mar 24, 2012
Showing with 13 additions and 23 deletions.
  1. +0 −1 docs/changes.md
  2. +0 −1 docs/migrating.md
  3. +5 −6 lib/cinch/bot.rb
  4. +2 −2 lib/cinch/configuration/bot.rb
  5. +4 −12 lib/cinch/plugin.rb
  6. +2 −1 lib/cinch/storage.rb
View
1 docs/changes.md
@@ -225,7 +225,6 @@ moved from {Cinch} to {Cinch::Constants}
#### {Cinch::Plugin}
- {Cinch::Plugin#handlers}
-- {Cinch::Plugin#storage}
- {Cinch::Plugin#timers}
- {Cinch::Plugin#unregister}
View
1 docs/migrating.md
@@ -18,7 +18,6 @@ shouldn't and usually mustn't overwrite:
- `#bot`
- `#config`
- `#handlers`
-- `#storage`
- `#synchronize`
- `#timers`
- `#unregister`
View
11 lib/cinch/bot.rb
@@ -47,7 +47,7 @@
require "cinch/configuration/plugins"
require "cinch/configuration/ssl"
require "cinch/configuration/timeouts"
-require "cinch/configuration/storage"
+# require "cinch/configuration/storage"
require "cinch/configuration/dcc"
require "cinch/configuration/sasl"
@@ -290,12 +290,11 @@ def start(plugins = true)
end while @config.reconnect and not @quitting
end
- # TODO document this
def stop
- @plugins.each do |plugin|
- plugin.storage.save
- plugin.storage.unload
- end
+ # @plugins.each do |plugin|
+ # plugin.storage.save
+ # plugin.storage.unload
+ # end
end
# @endgroup
View
4 lib/cinch/configuration/bot.rb
@@ -8,7 +8,7 @@ class Bot < Configuration
:realname, :user, :messages_per_second, :server_queue_size,
:strictness, :message_split_start, :message_split_end,
:max_messages, :plugins, :channels, :encoding, :reconnect, :max_reconnect_delay,
- :local_host, :timeouts, :ping_interval, :storage, :dcc, :shared, :sasl]
+ :local_host, :timeouts, :ping_interval, :dcc, :shared, :sasl]
# (see Configuration.default_config)
def self.default_config
@@ -37,7 +37,7 @@ def self.default_config
:timeouts => Configuration::Timeouts.new,
:ping_interval => 120,
:delay_joins => 0,
- :storage => Configuration::Storage.new,
+ # :storage => Configuration::Storage.new,
:dcc => Configuration::DCC.new,
:sasl => Configuration::SASL.new,
:shared => {},
View
16 lib/cinch/plugin.rb
@@ -10,7 +10,7 @@ module Cinch
#
# Most of the instance methods are for use by the Cinch framework
# and part of the private API, but some will also be used by plugin
- # authors, mainly {#config}, {#synchronize}, {#storage} and {#bot}.
+ # authors, mainly {#config}, {#synchronize} and {#bot}.
module Plugin
include Helpers
@@ -196,15 +196,7 @@ def match(pattern, options = {})
# @overload listen_to(*types, options = {})
# @param [String, Symbol, Integer] *types Events to listen to. Available
# events are all IRC commands in lowercase as symbols, all numeric
- # replies, and the following:
- #
- # - :channel (a channel message)
- # - :private (a private message)
- # - :message (both channel and private messages)
- # - :error (IRC errors)
- # - :ctcp (ctcp requests)
- # - :action (actions, aka /me)
- #
+ # replies and all events listed in the {file:docs/events.md list of events}.
# @param [Hash] options
# @option options [Symbol] :method (:listen) The method to
# execute
@@ -441,14 +433,14 @@ def __register
attr_reader :timers
# @return [Storage] The per-plugin persistent storage
- attr_reader :storage
+ # attr_reader :storage
# @api private
def initialize(bot)
@bot = bot
@handlers = []
@timers = []
- @storage = bot.config.storage.backend.new(@bot.config.storage, self)
+ # @storage = bot.config.storage.backend.new(@bot.config.storage, self)
__register
end
View
3 lib/cinch/storage.rb
@@ -1,5 +1,6 @@
module Cinch
- # @since 2.0.0
+ # @note The interface of this class isn't fixed yet. You shouldn't
+ # use it yet.
class Storage
include Enumerable

0 comments on commit bc957fa

Please sign in to comment.
Something went wrong with that request. Please try again.